yt 0.25.13 → 0.32.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f5d61a13c2ac1e501b0b8bf83b439f47afef4aee
-  data.tar.gz: 2bab9c7300548cfaea22154ba364eae4714eaf7c
+SHA256:
+  metadata.gz: 42cfba8fbb240b3272678d965ba64987563a9a2a2a8ae839a22df6a764722ae3
+  data.tar.gz: e81d7bb9c2cd64ae4fdc9d68dae7a39ae7ff2b0f3ffea3dc27a52103f8a21ec7
 SHA512:
-  metadata.gz: f24db663d4ddd8a36c054e4b7696fe656dd2ae555d72b5d856b9c0d520a00bf300dd43f54995d0f0ea7397004e352f2d64e52f13d3c12938d6eb06654da3d3eb
-  data.tar.gz: c515f09879b3761e9adc1aeb88a6c99c9a2754cb346fecb200efbff9b6ecd2eea41fb4642e26abb73e509c095e544e919a1c137384219102264d8b1511f3e6e2
+  metadata.gz: a2cbb015d4d363ca40d9238bffabd618edc534f250097ab58548a2f2676334a419dfe8cac893b282063fe03373a1b71f055f90f972d2489ce6e69e81237727f7
+  data.tar.gz: e0bb039d9acfbfb4d2403ffbad549dba4fa359ab9467a6faeed1ff6fe6137adf5dd8c307dbb025f8e4e7a8dc4cb3204a9ef78aff1ca8cfb77fc44ea4197b9fd2

data/CHANGELOG.md

@@ -6,6 +6,310 @@ For more information about changelogs, check
 [Keep a Changelog](http://keepachangelog.com) and
 [Vandamme](http://tech-angels.github.io/vandamme).
 
+## 0.32.2 - 2018-05-25
+
+* Use YouTube Analytics API v2 instead of v1. See announcement of v1 deprecation
+https://developers.google.com/youtube/analytics/revision_history#april-26-2018
+
+## 0.32.1 - 2017-08-14
+
+* [FEATURE] Add `Yt::ContentOwner#bulk_report_jobs`
+* [FEATURE] Add `Yt::BulkReportJob#bulk_reports`
+
+## 0.32.0 - 2017-07-05
+
+**How to upgrade**
+
+If your code is expecting data from `reports` methods to always include historical data (the data from the period before joining), now you have to set `historical: true` specifically. It will not include historical data by default.
+
+* [IMPROVEMENT] Include historical data with `historical: true` option.
+
+## 0.31.2 - 2017-06-29
+
+* [BUGFIX] Return lifetime data correctly even when the channel joined content owner after a while since it's created.
+
+## 0.31.1 - 2017-06-03
+
+* [FEATURE] Add `by: :youtube_product` option for reports.
+* [FEATURE] Add `Yt::Collections::Reports::YOUTUBE_PRODUCTS` to list all YouTube products (KIDS, GAMING, etc) supported by YouTube Analytics API.
+* [FEATURE] Add more operating system dimensions to `Yt::Collections::Reports::OPERATING_SYSTEMS`.
+
+## 0.31.0 - 2017-06-02
+
+**How to upgrade**
+
+If your code calls `.uniques` it should be removed because this metric has been
+no longer supported by YouTube API as of [October 31, 2016](https://developers.google.com/youtube/analytics/revision_history#september-27-2016).
+
+* [REMOVAL] Remove `#uniques` method for channels, videos and video groups.
+
+## 0.30.1 - 2017-04-14
+
+* [IMPROVEMENT] Retry 3 times if YouTube responds with 503 Backend Error
+
+## 0.30.0 - 2017-03-17
+
+**How to upgrade**
+
+If your code uses `Yt::Models::Configuration` then you must use
+`Yt::Configuration` instead.
+
+Both `Yt::Configuration` and `Yt::Config` have been moved in a separate
+gem called `yt-support` that is required by default by the `yt` gem.
+
+* [REMOVAL] Remove `Yt::Models::Configuration` (renamed as `Yt::Configuration`)
+
+## 0.29.1 - 2017-02-26
+
+* [FEATURE] Add `Video#length` to show the duration as an ISO 8601 time.
+
+## 0.29.0 - 2017-02-17
+
+**How to upgrade**
+
+If your code uses `Yt::URL` then you must include the `yt-url` gem, since
+`Yt::URL` has been extracted into a separate repository.
+Please read the documentation of `Yt::URL` and notice that the `subscription`
+pattern has been dropped, so URLs such as the following will not be recognized
+anymore: `subscription_center?add_user=...`, `subscribe_widget?p=...`.
+
+Note that this also removes the option of initializing a resource by URL.
+You can achieve the same result with the `yt-url` gem, as detailed in its
+documentation.
+
+Finally note that this also remove the class `Yt::Description`. This class
+was private API, so this change should not affect developers.
+
+* [REMOVAL] Remove the option to initialize resources by URL.
+* [REMOVAL] Remove `Yt::Resource.username`
+* [REMOVAL] Remove `Yt::URL` (extracted into separate gem)
+* [REMOVAL] Remove `Yt::Description` (now simply a String).
+
+## 0.28.5 - 2017-01-18
+
+* [BUGFIX] Don't crash when Yt::VideoGroup is initialized with a group of playlists.
+
+## 0.28.4 - 2017-01-18
+
+* [BUGFIX] Don't crash when Yt::VideoGroup is initialized with a group of playlists.
+
+## 0.28.3 - 2017-01-09
+
+* [FEATURE] Add `VideoGroup#channels` method to load all channels under a group.
+
+## 0.28.2 - 2017-01-09
+
+* [FEATURE] Add `channel_url` to video.
+
+## 0.28.1 - 2016-10-24
+
+* [FEATURE] New `card impressions` report for video groups.
+* [FEATURE] New `card clicks` report for video groups.
+* [FEATURE] New `card click rate` report for video groups.
+* [FEATURE] New `card teaser impressions` report for video groups.
+* [FEATURE] New `card teaser clicks` report for video groups.
+* [FEATURE] New `card teaser click rate` report for video groups.
+
+## 0.28.0 - 2016-10-18
+
+**How to upgrade**
+
+If your code calls `.earnings` and `.impressions`
+then you must replace that code  with `.estimated_revenue` and
+`.ad_impressions` since those metrics will no longer be supported by
+YouTube API as of [November 4, 2016](https://developers.google.com/youtube/analytics/revision_history#august-10-2016).
+
+* [REMOVAL] Remove `#earnings` method for channels, playlists, videos and video groups
+* [REMOVAL] Remove `#impressions` method for channels, videos and video groups
+* [FEATURE] Add `#estimated_revenue` method for channels, videos and video groups
+* [FEATURE] Add `#ad_impressions` method for channels, videos and video groups
+
+## 0.27.0 - 2016-10-07
+
+**How to upgrade**
+
+If your code calls any of the following `..._on` method to fetch metrics on
+a specific day, you need to replace it with the equivalent method that does
+not end with `_on`. For instance replace `views_on(3.days.ago)` with the
+equivalent `views(since: 3.days.ago, until: 3.days.ago)`.
+
+* [REMOVAL] Remove `#views_on` method for channels, playlists, videos and video groups
+* [REMOVAL] Remove `#uniques_on` method for channels, playlists, videos and video groups
+* [REMOVAL] Remove `#estimated_minutes_watched_on` method for channels, playlists, videos and video groups
+* [REMOVAL] Remove `#viewer_percentage_on` method for channels, playlists, videos and video groups
+* [REMOVAL] Remove `#comments_on` method for channels, playlists, videos and video groups
+* [REMOVAL] Remove `#likes_on` method for channels, playlists, videos and video groups
+* [REMOVAL] Remove `#dislikes_on` method for channels, playlists, videos and video groups
+* [REMOVAL] Remove `#shares_on` method for channels, playlists, videos and video groups
+* [REMOVAL] Remove `#subscribers_gained_on` method for channels, playlists, videos and video groups
+* [REMOVAL] Remove `#subscribers_lost_on` method for channels, playlists, videos and video groups
+* [REMOVAL] Remove `#videos_added_to_playlists_on` method for channels, playlists, videos and video groups
+* [REMOVAL] Remove `#videos_removed_from_playlists_on` method for channels, playlists, videos and video groups
+* [REMOVAL] Remove `#average_view_duration_on` method for channels, playlists, videos and video groups
+* [REMOVAL] Remove `#average_view_percentage_on` method for channels, playlists, videos and video groups
+* [REMOVAL] Remove `#annotation_clicks_on` method for channels, playlists, videos and video groups
+* [REMOVAL] Remove `#annotation_click_through_rate_on` method for channels, playlists, videos and video groups
+* [REMOVAL] Remove `#annotation_close_rate_on` method for channels, playlists, videos and video groups
+* [REMOVAL] Remove `#card_impressions_on` method for channels, playlists, videos and video groups
+* [REMOVAL] Remove `#card_clicks_on` method for channels, playlists, videos and video groups
+* [REMOVAL] Remove `#card_click_rate_on` method for channels, playlists, videos and video groups
+* [REMOVAL] Remove `#card_teaser_impressions_on` method for channels, playlists, videos and video groups
+* [REMOVAL] Remove `#card_teaser_clicks_on` method for channels, playlists, videos and video groups
+* [REMOVAL] Remove `#card_teaser_click_rate_on` method for channels, playlists, videos and video groups
+* [REMOVAL] Remove `#earnings_on` method for channels, playlists, videos and video groups
+* [REMOVAL] Remove `#impressions_on` method for channels, playlists, videos and video groups
+* [REMOVAL] Remove `#monetized_playbacks_on` method for channels, playlists, videos and video groups
+* [REMOVAL] Remove `#playback_based_cpm_on` method for channels, playlists, videos and video groups
+
+## 0.26.3 - 2016-10-07
+
+* [FEATURE] Add `by: :subscribed_status` option for reports, to return views (from a `content_owner.video`) by subscribed status.
+* [FEATURE] Add `Yt::Collections::Reports::SUBSCRIBED_STATUSES` to list all subscribed statuses supported by YouTube Analytics API.
+
+## 0.26.2 - 2016-10-05
+
+* [ENHANCEMENT] Add newly available traffic sources: "Campaign card" and "End screen"
+
+## 0.26.1 - 2016-10-05
+
+* [FEATURE] New `card impressions` report for videos and channels.
+* [FEATURE] New `card clicks` report for videos and channels.
+* [FEATURE] New `card click rate` report for videos and channels.
+* [FEATURE] New `card teaser impressions` report for videos and channels.
+* [FEATURE] New `card teaser clicks` report for videos and channels.
+* [FEATURE] New `card teaser click rate` report for videos and channels.
+
+## 0.26.0 - 2016-10-05
+
+**How to upgrade**
+
+If your code calls `.favorites_added` and `.favorites_removed` on channels and
+videos then you must remove that code since those metrics are not anymore
+supported by YouTube API.
+
+* [REMOVAL] Remove deprecated `favorites_added` metric for channels, videos, and video groups.
+* [REMOVAL] Remove deprecated `favorites_removed` metric for channels, videos, and video groups
+
+## 0.25.40 - 2016-09-19
+
+* [IMPROVEMENT] Add `Yt::Claim#data` to access the policy of a claim
+
+## 0.25.39 - 2016-06-15
+
+* [FEATURE] Add `by: :operating_system` option for reports, to return views (from a `content_owner.video`) by operating system.
+* [FEATURE] Add `Yt::Collections::Reports::DEVICE_TYPES` to list all device types supported by YouTube Analytics API.
+* [FEATURE] Add `Yt::Collections::Reports::OPERATING_SYSTEMS` to list all operating systems supported by YouTube Analytics API.
+
+## 0.25.38 - 2016-06-13
+
+* [IMPROVEMENT] Don’t combine forContentOwner and publishedBefore parameters in Search#list since YouTube does not support this anymore.
+
+## 0.25.37  - 2016-05-16
+
+* [FEATURE] Add `VideoGroup#videos` to load all videos under a group of channels, as well as a group of videos.
+
+## 0.25.36  - 2016-05-10
+
+* [BUGFIX] Raise RequestError when authentication code is "invalid" or "already redeemed"
+* [FEATURE] Make two methods `#explanation` and `#response_body` public for `Yt::Errors::RequestError`
+
+## 0.25.35  - 2016-04-27
+
+* [BUGFIX] Don’t try to eager load more than 50 assets at the time from claims
+
+## 0.25.34  - 2016-04-20
+
+* [FEATURE] Add `ad_breaks` and `tp_ad_server_video_id` attribute to AdvertisingOptionsSet
+
+## 0.25.33 - 2016-04-15
+
+* [FEATURE] Eager-loading claims from videos will also eager-load assets.
+* [FEATURE] New method - `Claim#source` will return the source of the claim.
+
+## 0.25.32 - 2016-04-12
+
+* [BUGFIX] Fix where videos did not eager load claims or categories in subsequent requests.
+
+## 0.25.31 - 2016-04-11
+
+* [BUGFIX] Don’t try to instantiate video.claim if a video does not have a claim.
+
+## 0.25.30 - 2016-04-07
+
+* [FEATURE] Add ability for videos to eager load claims. For example, `$content_owner.videos.includes(:claim).first.claim.id`.
+
+## 0.25.29 - 2016-04-07
+
+* [BUGFIX] Previously, Yt was throttling queries for `quotaExceeded` responses from YouTube. However, matching `quotaExceeded` was too specific and would not have caught other limit exceeding responses from YouTube. This change will allow Yt to throttle other responses that contains `Exceeded` or `exceeded`.
+
+## 0.25.28 - 2016-04-05
+
+* [BUGFIX] If no asset ID is set, calling ContentOwner#assets will now use the path, /youtube/partner/v1/assetSearch, instead of '/youtube/partner/v1/assets'
+
+## 0.25.27 - 2016-03-28
+
+* [FEATURE] Add `comment_threads` association to Yt::Video.
+* [FEATURE] Add `top_level_comment` and delegate its attributes (`text_display`, `author_display_name`, `like_count`, `updated_at`) to Yt::CommentThread.
+
+## 0.25.26 - 2016-03-24
+
+* [FEATURE] Add Yt::Comment resource.
+
+## 0.25.25 - 2016-03-24
+
+* [FEATURE] Add Yt::CommentThread resource.
+
+## 0.25.24 - 2016-03-02
+
+* [BUGFIX] When `videos.where(..)` returns more than one page, don’t retain the items for the next request.
+
+## 0.25.23 - 2016-02-23
+
+* [IMPROVEMENT] Retry 3 times after a server error, to bypass temporary glitches by YouTube.
+* [IMPROVEMENT] Don’t combine forMine and publishedBefore parameters in Search#list since YouTube does not support this anymore.
+
+## 0.25.22 - 2016-02-04
+
+* [IMPROVEMENT] Deal with channels with more than 500 videos in a better way
+
+## 0.25.21 - 2016-02-04
+
+* [BUGFIX] Add required 'require' to have `.with_indifferent_access` in geography
+
+## 0.25.20 - 2016-01-24
+
+* [FEATURE] Add (undocumented) playback location dimensions SEARCH and BROWSE
+
+## 0.25.19 - 2016-01-15
+
+* [FEATURE] Add `:group_items` to Yt::VideoGroup (list items of a group)
+* [FEATURE] Add `:includes(:video)` to `Yt::VideoGroup#group_items` (eagerly loads all the videos)
+
+## 0.25.18 - 2016-01-08
+
+* [FEATURE] Add Yt::COUNTRIES and Yt::US_STATES
+* [FEATURE] Add YouTube Analytics Video Groups
+* [FEATURE] Add `:video_groups` to Yt::Account (list video-groups created by an account)
+* [FEATURE] Add `:video_groups` to Yt::ContentOwner (list video-groups on behalf of a content owner)
+* [FEATURE] Add reports by video-group
+
+## 0.25.17 - 2016-01-05
+
+* [FEATURE] Add `:videos` to Yt::ContentOwner to list videos in network with a content owner
+
+## 0.25.16 - 2015-12-19
+
+* [FEATURE] Add `access_token_was_refreshed` to Yt::Account
+
+## 0.25.15 - 2015-12-17
+
+* [FEATURE] Add `revoke_access` to Yt::Account
+
+## 0.25.14 - 2015-12-16
+
+* [ENHANCEMENT] Add `:display_name` to each content owner returned by account.content_owners
+* [BUGFIX] Don’t raise error when raising MissingAuth without any scope
+
 ## 0.25.13 - 2015-12-04
 
 * [BUGFIX] Fix previous fix to Video#update with publishAt (typo)
@@ -458,7 +762,7 @@ error by using the `unsubscribe` method:
 
 ## 0.11.5 - 2014-08-27
 
-* [BUGFIX] Make videos.where(id: 'MESycYJytkU').first.id return 'MESycYJytkU'
+* [BUGFIX] Make videos.where(id: 'jNQXAC9IVRw').first.id return 'jNQXAC9IVRw'
 
 ## 0.11.4 - 2014-08-27
 

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2014 Fullscreen, Inc.
+Copyright (c) 2014–present Fullscreen, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -23,11 +23,14 @@ channel.videos.count #=> 12
 ```
 
 ```ruby
-video = Yt::Video.new id: 'MESycYJytkU'
+video = Yt::Video.new id: 'jNQXAC9IVRw'
 video.title #=> "Fullscreen Creator Platform"
 video.comment_count #=> 308
 video.hd? #=> true
 video.annotations.count #=> 1
+video.comment_threads #=> #<Yt::Collections::CommentThreads ...>
+# Use #take to limit the number of pages need to fetch from server
+video.comment_threads.take(99).map(&:author_display_name) #=> ["Paul", "Tommy", ...]
 ```
 
 The **full documentation** is available at [rubydoc.info](http://www.rubydoc.info/gems/yt/frames).
@@ -41,7 +44,7 @@ To install on your system, run
 
 To use inside a bundled Ruby project, add this line to the Gemfile:
 
-    gem 'yt', '~> 0.25.5'
+    gem 'yt', '~> 0.28.0'
 
 Since the gem follows [Semantic Versioning](http://semver.org),
 indicating the full version in your Gemfile (~> *major*.*minor*.*patch*)
@@ -68,6 +71,7 @@ Use [Yt::ContentOwner](http://www.rubydoc.info/gems/yt/Yt/Models/ContentOwner) t
 * list and delete the references administered by the content owner
 * list the policies and policy rules administered by the content owner
 * create assets
+* list assets
 
 ```ruby
 # Content owners can be initialized with access token, refresh token or an authorization code
@@ -79,7 +83,7 @@ content_owner.partnered_channels.where(part: 'statistics').map &:subscriber_coun
 
 content_owner.claims.where(q: 'Fullscreen').count #=> 24
 content_owner.claims.first #=> #<Yt::Models::Claim @id=...>
-content_owner.claims.first.video_id #=> 'MESycYJytkU'
+content_owner.claims.first.video_id #=> 'jNQXAC9IVRw'
 content_owner.claims.first.status #=> "active"
 
 reference = content_owner.references.where(asset_id: "ABCDEFG").first #=> #<Yt::Models::Reference @id=...>
@@ -92,6 +96,13 @@ content_owner.policies.first.rules.first.action #=> "monetize"
 content_owner.policies.first.rules.first.included_territories #=> ["US", "CA"]
 
 content_owner.create_asset type: 'web' #=> #<Yt::Models::Asset @id=...>
+
+content_owner.assets.first #=> #<Yt::Models::AssetSnippet:0x007ff2bc543b00 @id=...>
+content_owner.assets.first.id #=> "A4532885163805730"
+content_owner.assets.first.title #=> "Money Train"
+content_owner.assets.first.type #=> "web"
+content_owner.assets.first.custom_id #=> "MoKNJFOIRroc"
+
 ```
 
 *All the above methods require authentication (see below).*
@@ -116,6 +127,76 @@ Yt::PlaylistItem
 
 Check [fullscreen.github.io/yt](http://fullscreen.github.io/yt/playlist_items.html) for the list of methods available for `Yt::PlaylistItem`.
 
+Yt::CommentThread
+----------------
+
+Use [Yt::CommentThread](http://www.rubydoc.info/gems/yt/Yt/Models/CommentThread) to:
+
+* Show details of a comment_thread.
+
+```ruby
+Yt::CommentThread.new id: 'z13vsnnbwtv4sbnug232erczcmi3wzaug'
+
+comment_thread.video_id #=> "1234"
+comment_thread.total_reply_count #=> 1
+comment_thread.can_reply? #=> true
+comment_thread.public? #=> true
+
+comment_thread.top_level_comment #=> #<Yt::Models::Comment ...>
+comment_thread.text_display #=> "funny video!"
+comment_thread.like_count #=> 9
+comment_thread.updated_at #=> 2016-03-22 12:56:56 UTC
+comment_thread.author_display_name #=> "Joe"
+```
+
+Yt::Comment
+----------------
+
+Use [Yt::Comment](http://www.rubydoc.info/gems/yt/Yt/Models/Comment) to:
+
+* Get details of a comment.
+
+```ruby
+Yt::Comment.new id: 'z13vsnnbwtv4sbnug232erczcmi3wzaug'
+
+comment.text_display #=> "awesome"
+comment.author_display_name #=> "Jack"
+comment.like_count #=> 1
+comment.updated_at #=> 2016-03-22 12:56:56 UTC
+comment.parent_id #=> "abc1234" (return nil if the comment is not a reply)
+```
+
+Yt::BulkReportJob
+----------------
+
+Use [Yt::BulkReportJob](http://www.rubydoc.info/gems/yt/Yt/Models/BulkReportJob) to:
+
+* Get details of a bulk report job.
+
+```ruby
+content_owner = Yt::ContentOwner.new owner_name: 'CMSname', access_token: 'ya29.1.ABCDEFGHIJ'
+bulk_report_job = content_owner.bulk_report_jobs.first
+
+bulk_report_job.report_type_id #=> "content_owner_demographics_a1"
+```
+
+Yt::BulkReport
+----------------
+
+Use [Yt::BulkReport](http://www.rubydoc.info/gems/yt/Yt/Models/BulkReport) to:
+
+* Get details of a bulk report.
+
+```ruby
+content_owner = Yt::ContentOwner.new owner_name: 'CMSname', access_token: 'ya29.1.ABCDEFGHIJ'
+bulk_report_job = content_owner.bulk_report_jobs.first
+bulk_report = bulk_report_job.bulk_reports.first
+
+bulk_report.start_time #=> 2017-08-11 07:00:00 UTC
+bulk_report.end_time #=> 2017-08-12 07:00:00 UTC
+bulk_report.download_url #=> "https://youtubereporting.googleapis.com/v1/..."
+```
+
 Yt::Collections::Videos
 -----------------------
 
@@ -128,7 +209,7 @@ videos = Yt::Collections::Videos.new
 videos.where(order: 'viewCount').first.title #=>  "PSY - GANGNAM STYLE"
 videos.where(q: 'Fullscreen CreatorPlatform', safe_search: 'none').size #=> 324
 videos.where(chart: 'mostPopular', video_category_id: 44).first.title #=> "SINISTER - Trailer"
-videos.where(id: 'MESycYJytkU,invalid').map(&:title) #=> ["Fullscreen Creator Platform"]
+videos.where(id: 'jNQXAC9IVRw,invalid').map(&:title) #=> ["Fullscreen Creator Platform"]
 ```
 
 *The methods above do not require authentication.*
@@ -243,7 +324,7 @@ Use [Yt::AdvertisingOptionsSet](http://www.rubydoc.info/gems/yt/Yt/Models/Advert
 
 ```ruby
 content_owner = Yt::ContentOwner.new owner_name: 'CMSname', access_token: 'ya29.1.ABCDEFGHIJ'
-ad_options = Yt::AdvertisingOptionsSet.new video_id: 'MESycYJytkU', auth: $content_owner
+ad_options = Yt::AdvertisingOptionsSet.new video_id: 'jNQXAC9IVRw', auth: $content_owner
 ad_options.update ad_formats: %w(standard_instream long) #=> true
 ```