yt 0.14.0 → 0.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e12f9ef5c2b615833df8d63a3a821aadd397a3b
-  data.tar.gz: e79d293fdbaaeaf10c2c6bc5fc594363e31909a2
+  metadata.gz: db4db84624546717fdc851f9686077c0926798ac
+  data.tar.gz: 69322165d6a6a13484613c7d1f3e3fda0c3c79d4
 SHA512:
-  metadata.gz: 8c2d5f5ff6825b5f844903ffec97c794c40b75d44489736b9ba8116d838adceadff3fff0fad0d8f641937c76c27476ed5e322f5e232119483d486420bb60e3c4
-  data.tar.gz: d44fc9bcb26d18178da67a651419ca69e3be7bce825cedfc68b22dc2b996b84728b9cf483e152da2947db6a2c4b6ce1691201b443a2675d7bdd6bac2cfad6d6a
+  metadata.gz: fe0e64e30469c9539c4e5441e6d691bf91f6bf3f66e5d1cfbf6aa4a790a79e21aeeea6a4c2e02eb4d147817467e052409789054bd369268cba906759563fd655
+  data.tar.gz: c4e6b9bbab1327dcc20acbdd65260d83b6ec06723a21a098efcb0bbb6fc5ef9555a6897d1a86dd48b120e86ee58857b051c383089f1503a49c48bce8659098be

data/CHANGELOG.md

@@ -6,6 +6,15 @@ For more information about changelogs, check
 [Keep a Changelog](http://keepachangelog.com) and
 [Vandamme](http://tech-angels.github.io/vandamme).
 
+## 0.14.1 - 2015-03-30
+
+* [FEATURE] New `monetized playbacks` report for channels.
+* [FEATURE] New `estimated watched minutes` report for videos.
+* [FEATURE] New video reports: `average_view_duration`, `average_view_percentage`.
+* [FEATURE] New `by: :playlist` option for reports, to return views and estimated watched minutes (channels) by playlist.
+* [FEATURE] New playlist reports: `views`, `playlist_starts`, `average_time_in_playlist`, `views_per_playlist_start`.
+
+
 ## 0.14.0 - 2015-03-25
 
 * [FEATURE] New `by: :traffic_source` option for reports, to return views (channels/videos) and estimated watched minutes (channels) by traffic source.

data/Gemfile

@@ -1,6 +1,4 @@
 source 'https://rubygems.org'
-gem 'pry'
-gem 'pry-nav'
 
 # Specify your gem's dependencies in yt.gemspec
 gemspec

data/README.md

@@ -41,7 +41,7 @@ To install on your system, run
 
 To use inside a bundled Ruby project, add this line to the Gemfile:
 
-    gem 'yt', '~> 0.13.11'
+    gem 'yt', '~> 0.14.1'
 
 Since the gem follows [Semantic Versioning](http://semver.org),
 indicating the full version in your Gemfile (~> *major*.*minor*.*patch*)
@@ -150,6 +150,8 @@ Use [Yt::Channel](http://rubydoc.info/github/Fullscreen/yt/master/Yt/Models/Chan
 * delete playlists from a channel
 * retrieve the daily earnings, views, comments, likes, dislikes, shares, subscribers gained/lost, estimated/average video watch and impressions of a channel by day
 * retrieve the views and estimated minutes watched by traffic source
+* retrieve the views and estimated minutes watched by video
+* retrieve the views and estimated minutes watched by playlist
 * retrieve the viewer percentage of a channel by gender and age group
 
 ```ruby
@@ -214,6 +216,12 @@ channel.viewer_percentage(gender: :male) #=> 49.12
 
 channel.views since: 7.days.ago, by: :traffic_source #=> {advertising: 10.0, related_video: 20.0, promoted: 5.0, subscriber: 1.0, channel: 3.0, other: 7.0}
 channel.estimated_minutes_watched since: 7.days.ago, by: :traffic_source #=> {annotation: 10.0, external_app: 20.0, external_url: 5.0, embedded: 1.0, search: 3.0}
+
+channel.views since: 7.days.ago, by: :video #=> {#<Yt::Models::Video @id=...>: 10.0, #<Yt::Models::Video @id=...>: 20.0, …}
+channel.estimated_minutes_watched since: 7.days.ago, by: :video #=> {#<Yt::Models::Video @id=...>: 10.0, #<Yt::Models::Video @id=...>: 20.0, …}
+
+channel.views since: 7.days.ago, by: :playlist #=> {#<Yt::Models::Playlist @id=...>: 10.0, #<Yt::Models::Playlist @id=...>: 20.0, …}
+channel.estimated_minutes_watched since: 7.days.ago, by: :playlist #=> {#<Yt::Models::Playlist @id=...>: 10.0, #<Yt::Models::Playlist @id=...>: 20.0, …}
 ```
 
 *The methods above require to be authenticated as the channel’s account (see below).*
@@ -238,6 +246,11 @@ channel.viewer_percentages #=> {female: {'18-24' => 12.12, '25-34' => 16.16,…}
 channel.viewer_percentage(gender: :female) #=> 49.12
 channel.views since: 7.days.ago, by: :traffic_source #=> {advertising: 10.0, related_video: 20.0, promoted: 5.0, subscriber: 1.0, channel: 3.0, other: 7.0}
 channel.estimated_minutes_watched since: 7.days.ago, by: :traffic_source #=> {annotation: 10.0, external_app: 20.0, external_url: 5.0, embedded: 1.0, search: 3.0}
+channel.views since: 7.days.ago, by: :video #=> {#<Yt::Models::Video @id=...>: 10.0, #<Yt::Models::Video @id=...>: 20.0, …}
+channel.estimated_minutes_watched since: 7.days.ago, by: :video #=> {#<Yt::Models::Video @id=...>: 10.0, #<Yt::Models::Video @id=...>: 20.0, …}
+channel.views since: 7.days.ago, by: :playlist #=> {#<Yt::Models::Playlist @id=...>: 10.0, #<Yt::Models::Playlist @id=...>: 20.0, …}
+channel.estimated_minutes_watched since: 7.days.ago, by: :playlist #=> {#<Yt::Models::Playlist @id=...>: 10.0, #<Yt::Models::Playlist @id=...>: 20.0, …}
+channel.monetized_playbacks_on 5.days.ago #=> 123.0
 
 channel.content_owner #=> 'CMSname'
 channel.linked_at #=> Wed, 28 May 2014
@@ -350,6 +363,11 @@ video.dislikes to: 2.days.ago #=> {Tue, 27 May 2014 => 0.0, Wed, 28 May 2014 =>
 video.shares since: 7.days.ago, until: 7.days.ago  #=> {Wed, 28 May 2014 => 3.0}
 video.subscribers_gained from: '2014-08-30', to: '2014-08-31' #=> {Sat, 30 Aug 2014=>1.0, Sun, 31 Aug 2014=>0.0}
 video.subscribers_lost from: '2014-08-30', to: '2014-08-31' #=> {Sat, 30 Aug 2014=>0.0, Sun, 31 Aug 2014=>0.0}
+video.favorites_added from: '2014-08-30', to: '2014-08-31' #=> {Sat, 30 Aug 2014=>1.0, Sun, 31 Aug 2014=>0.0}
+video.favorites_removed from: '2014-08-30', to: '2014-08-31' #=> {Sat, 30 Aug 2014=>0.0, Sun, 31 Aug 2014=>0.0}
+video.average_view_duration #=>  {Sun, 22 Feb 2015=>329.0, Mon, 23 Feb 2015=>326.0, …}
+video.average_view_percentage # {Sun, 22 Feb 2015=>38.858253094977265, Mon, 23 Feb 2015=>37.40014235438217, …}
+video.estimated_minutes_watched #=> {Sun, 22 Feb 2015=>2433258.0, Mon, 23 Feb 2015=>2634360.0, …}
 video.viewer_percentages #=> {female: {'18-24' => 12.12, '25-34' => 16.16,…}…}
 video.viewer_percentage(gender: :female) #=> 49.12
 
@@ -372,6 +390,11 @@ video.dislikes to: 2.days.ago #=> {Tue, 27 May 2014 => 0.0, Wed, 28 May 2014 =>
 video.shares since: 7.days.ago, until: 7.days.ago  #=> {Wed, 28 May 2014 => 3.0}
 video.subscribers_gained from: '2014-08-30', to: '2014-08-31' #=> {Sat, 30 Aug 2014=>1.0, Sun, 31 Aug 2014=>0.0}
 video.subscribers_lost from: '2014-08-30', to: '2014-08-31' #=> {Sat, 30 Aug 2014=>0.0, Sun, 31 Aug 2014=>0.0}
+video.favorites_added from: '2014-08-30', to: '2014-08-31' #=> {Sat, 30 Aug 2014=>1.0, Sun, 31 Aug 2014=>0.0}
+video.favorites_removed from: '2014-08-30', to: '2014-08-31' #=> {Sat, 30 Aug 2014=>0.0, Sun, 31 Aug 2014=>0.0}
+video.average_view_duration #=>  {Sun, 22 Feb 2015=>329.0, Mon, 23 Feb 2015=>326.0, …}
+video.average_view_percentage # {Sun, 22 Feb 2015=>38.858253094977265, Mon, 23 Feb 2015=>37.40014235438217, …}
+video.estimated_minutes_watched #=> {Sun, 22 Feb 2015=>2433258.0, Mon, 23 Feb 2015=>2634360.0, …}
 video.impressions_on 5.days.ago #=> 157.0
 video.monetized_playbacks_on 5.days.ago #=> 123.0
 
@@ -395,6 +418,7 @@ Use [Yt::Playlist](http://rubydoc.info/github/Fullscreen/yt/master/Yt/Models/Pla
 * access the items of a playlist
 * add one or multiple videos to a playlist
 * delete items from a playlist
+* retrieve the views, playlist starts, average time in playlist and views per playlist start of a playlist by day
 
 ```ruby
 # Playlists can be initialized with ID or URL
@@ -421,6 +445,19 @@ playlist.update title: 'A <title> with angle brackets', description: 'desc', tag
 playlist.add_video 'MESycYJytkU', position: 2
 playlist.add_videos ['MESycYJytkU', 'MESycYJytkU']
 playlist.delete_playlist_items title: 'Fullscreen Creator Platform' #=> [true]
+
+playlist.views_on 5.days.ago #=> 12.0
+playlist.views since: 7.days.ago #=> {Wed, 28 May 2014 => 12.0, Thu, 29 May 2014 => 3.0, …}
+
+playlist.playlist_starts_on 5.days.ago #=> 12.0
+playlist.playlist_starts since: 7.days.ago #=> {Wed, 28 May 2014 => 12.0, Thu, 29 May 2014 => 3.0, …}
+
+playlist.average_time_in_playlist_on 5.days.ago #=> 12.0
+playlist.average_time_in_playlist since: 7.days.ago #=> {Wed, 28 May 2014 => 12.0, Thu, 29 May 2014 => 3.0, …}
+
+playlist.views_per_playlist_start_on 5.days.ago #=> 12.0
+playlist.views_per_playlist_start since: 7.days.ago #=> {Wed, 28 May 2014 => 12.0, Thu, 29 May 2014 => 3.0, …}
+
 ```
 
 *The methods above require to be authenticated as the playlist’s owner (see below).*

data/lib/yt/collections/reports.rb

@@ -6,6 +6,7 @@ module Yt
       DIMENSIONS = Hash.new({name: 'day', parse: -> (day) {Date.iso8601 day} }).tap do |hash|
         hash[:traffic_source] = {name: 'insightTrafficSourceType', parse: -> (type) {TRAFFIC_SOURCES.key type} }
         hash[:video] = {name: 'video', parse: -> (video_id) { Yt::Video.new id: video_id, auth: @auth } }
+        hash[:playlist] = {name: 'playlist', parse: -> (playlist_id) { Yt::Playlist.new id: playlist_id, auth: @auth } }
       end
 
       # @see https://developers.google.com/youtube/analytics/v1/dimsmets/dims#Traffic_Source_Dimensions
@@ -64,7 +65,9 @@ module Yt
           params['metrics'] = @metric.to_s.camelize(:lower)
           params['dimensions'] = DIMENSIONS[@dimension][:name]
           params['max-results'] = 10 if @dimension == :video
-          params['sort'] = "-#{@metric.to_s.camelize(:lower)}" if @dimension == :video
+          params['max-results'] = 200 if @dimension == :playlist
+          params['sort'] = "-#{@metric.to_s.camelize(:lower)}" if @dimension.in? [:video, :playlist]
+          params[:filters] = ((params[:filters] || '').split(';') + ['isCurated==1']).compact.uniq.join(';') if @dimension == :playlist
         end
       end
 

data/lib/yt/models/channel.rb

@@ -55,6 +55,9 @@ module Yt
       # @macro has_report
       has_report :impressions
 
+      # @macro has_report
+      has_report :monetized_playbacks
+
       # @macro has_viewer_percentages
       has_viewer_percentages
 

data/lib/yt/models/playlist.rb

@@ -11,6 +11,18 @@ module Yt
       #   @return [Yt::Collections::PlaylistItems] the playlist’s items.
       has_many :playlist_items
 
+      # @macro has_report
+      has_report :views
+
+      # @macro has_report
+      has_report :playlist_starts
+
+      # @macro has_report
+      has_report :average_time_in_playlist
+
+      # @macro has_report
+      has_report :views_per_playlist_start
+
       # Deletes the playlist.
       #
       # This method requires {Resource#auth auth} to return an authenticated
@@ -57,6 +69,21 @@ module Yt
         playlist_items.delete_all attrs
       end
 
+      # @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
+      def reports_params
+        {}.tap do |params|
+          if auth.owner_name
+            params[:ids] = "contentOwner==#{auth.owner_name}"
+          else
+            params[:ids] = "channel==#{channel_id}"
+          end
+          params[:filters] = "playlist==#{id};isCurated==1"
+        end
+      end
+
     private
 
       # @see https://developers.google.com/youtube/v3/docs/playlists/update

data/lib/yt/models/video.rb

@@ -74,6 +74,15 @@ module Yt
       # @macro has_report
       has_report :favorites_removed
 
+      # @macro has_report
+      has_report :estimated_minutes_watched
+
+      # @macro has_report
+      has_report :average_view_duration
+
+      # @macro has_report
+      has_report :average_view_percentage
+
       # @macro has_report
       has_report :impressions
 

data/lib/yt/version.rb

@@ -1,3 +1,3 @@
 module Yt
-  VERSION = '0.14.0'
+  VERSION = '0.14.1'
 end

data/spec/requests/as_account/channel_spec.rb

@@ -139,6 +139,7 @@ describe Yt::Channel, :device_app do
       expect{channel.average_view_percentage}.not_to raise_error
       expect{channel.earnings}.to raise_error Yt::Errors::Unauthorized
       expect{channel.impressions}.to raise_error Yt::Errors::Unauthorized
+      expect{channel.monetized_playbacks}.to raise_error Yt::Errors::Unauthorized
 
       expect{channel.views_on 3.days.ago}.not_to raise_error
       expect{channel.comments_on 3.days.ago}.not_to raise_error

data/spec/requests/as_account/playlist_spec.rb

@@ -175,4 +175,20 @@ describe Yt::Playlist, :device_app do
       end
     end
   end
+
+  context 'given one of my own playlists that I want to get reports for' do
+    let(:id) { $account.channel.playlists.first.id }
+
+    it 'returns valid reports for playlist-related metrics' do
+      expect{playlist.views}.not_to raise_error
+      expect{playlist.playlist_starts}.not_to raise_error
+      expect{playlist.average_time_in_playlist}.not_to raise_error
+      expect{playlist.views_per_playlist_start}.not_to raise_error
+
+      expect{playlist.views_on 3.days.ago}.not_to raise_error
+      expect{playlist.playlist_starts_on 3.days.ago}.not_to raise_error
+      expect{playlist.average_time_in_playlist_on 3.days.ago}.not_to raise_error
+      expect{playlist.views_per_playlist_start_on 3.days.ago}.not_to raise_error
+    end
+  end
 end

data/spec/requests/as_account/video_spec.rb

@@ -289,6 +289,9 @@ describe Yt::Video, :device_app do
       expect{video.subscribers_lost}.not_to raise_error
       expect{video.favorites_added}.not_to raise_error
       expect{video.favorites_removed}.not_to raise_error
+      expect{video.estimated_minutes_watched}.not_to raise_error
+      expect{video.average_view_duration}.not_to raise_error
+      expect{video.average_view_percentage}.not_to raise_error
       expect{video.earnings}.to raise_error Yt::Errors::Unauthorized
       expect{video.impressions}.to raise_error Yt::Errors::Unauthorized
       expect{video.monetized_playbacks}.to raise_error Yt::Errors::Unauthorized
@@ -303,6 +306,9 @@ describe Yt::Video, :device_app do
       expect{video.subscribers_lost_on 3.days.ago}.not_to raise_error
       expect{video.favorites_added_on 3.days.ago}.not_to raise_error
       expect{video.favorites_removed_on 3.days.ago}.not_to raise_error
+      expect{video.estimated_minutes_watched_on 3.days.ago}.not_to raise_error
+      expect{video.average_view_duration_on 3.days.ago}.not_to raise_error
+      expect{video.average_view_percentage_on 3.days.ago}.not_to raise_error
       expect{video.earnings_on 3.days.ago}.to raise_error Yt::Errors::Unauthorized
       expect{video.impressions_on 3.days.ago}.to raise_error Yt::Errors::Unauthorized
     end

data/spec/requests/as_content_owner/channel_spec.rb

@@ -1,6 +1,7 @@
 # encoding: UTF-8
 require 'spec_helper'
 require 'yt/models/channel'
+require 'yt/models/playlist'
 
 describe Yt::Channel, :partner do
   subject(:channel) { Yt::Channel.new id: id, auth: $content_owner }
@@ -120,6 +121,15 @@ describe Yt::Channel, :partner do
         end
       end
 
+      describe 'views can be grouped by playlist' do
+        let(:range) { {since: 4.days.ago, until: 3.days.ago} }
+
+        specify 'with the :by option set to :playlist' do
+          views = channel.views range.merge by: :playlist
+          expect(views.keys).to all(be_instance_of Yt::Playlist)
+        end
+      end
+
       describe 'comments can be retrieved for a specific day' do
         context 'in which the channel was partnered' do
           let(:comments) { channel.comments_on 5.days.ago}
@@ -562,6 +572,15 @@ describe Yt::Channel, :partner do
         end
       end
 
+      describe 'estimated minutes watched can be grouped by playlist' do
+        let(:range) { {since: 4.days.ago, until: 3.days.ago} }
+
+        specify 'with the :by option set to :playlist' do
+          estimated_minutes_watched = channel.estimated_minutes_watched range.merge by: :playlist
+          expect(estimated_minutes_watched.keys).to all(be_instance_of Yt::Playlist)
+        end
+      end
+
       describe 'average view duration can be retrieved for a specific day' do
         context 'in which the channel was partnered' do
           let(:average_view_duration) { channel.average_view_duration_on 5.days.ago}
@@ -703,6 +722,53 @@ describe Yt::Channel, :partner do
         end
       end
 
+      describe 'monetized playbacks can be retrieved for a specific day' do
+        context 'in which the channel was partnered' do
+          let(:monetized_playbacks) { channel.monetized_playbacks_on 20.days.ago}
+          it { expect(monetized_playbacks).to be_a Float }
+        end
+
+        context 'in which the channel was not partnered' do
+          let(:monetized_playbacks) { channel.monetized_playbacks_on 20.years.ago}
+          it { expect(monetized_playbacks).to be_nil }
+        end
+      end
+
+      describe 'monetized playbacks can be retrieved for a range of days' do
+        let(:date) { 4.days.ago }
+
+        specify 'with a given start (:since option)' do
+          expect(channel.monetized_playbacks(since: date).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given end (:until option)' do
+          expect(channel.monetized_playbacks(until: date).keys.max).to eq date.to_date
+        end
+
+        specify 'with a given start (:from option)' do
+          expect(channel.monetized_playbacks(from: date).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given end (:to option)' do
+          expect(channel.monetized_playbacks(to: date).keys.max).to eq date.to_date
+        end
+      end
+
+      describe 'monetized_playbacks can be grouped by day' do
+        let(:range) { {since: 4.days.ago.to_date, until: 3.days.ago.to_date} }
+        let(:keys) { range.values }
+
+        specify 'without a :by option (default)' do
+          monetized_playbacks = channel.monetized_playbacks range
+          expect(monetized_playbacks.keys).to eq range.values
+        end
+
+        specify 'with the :by option set to :day' do
+          monetized_playbacks = channel.monetized_playbacks range.merge by: :day
+          expect(monetized_playbacks.keys).to eq range.values
+        end
+      end
+
       specify 'viewer percentages by gender and age range can be retrieved' do
         expect(channel.viewer_percentages[:female]['18-24']).to be_a Float
         expect(channel.viewer_percentages[:female]['25-34']).to be_a Float

data/spec/requests/as_content_owner/playlist_spec.rb

@@ -0,0 +1,213 @@
+# encoding: UTF-8
+require 'spec_helper'
+require 'yt/models/channel'
+require 'yt/models/playlist'
+
+describe Yt::Playlist, :partner do
+  subject(:playlist) { Yt::Playlist.new id: id, auth: $content_owner }
+
+  context 'given a playlist of a partnered channel', :partner do
+    context 'managed by the authenticated Content Owner' do
+      let(:id) { ENV['YT_TEST_PARTNER_PLAYLIST_ID'] }
+
+      describe 'views can be retrieved for a specific day' do
+        context 'in which the playlist was viewed' do
+          let(:views) { playlist.views_on ENV['YT_TEST_PARTNER_PLAYLIST_DATE']}
+          it { expect(views).to be_a Float }
+        end
+
+        context 'in which the playlist was not viewed' do
+          let(:views) { playlist.views_on 20.years.ago}
+          it { expect(views).to be_nil }
+        end
+      end
+
+      describe 'views can be retrieved for a range of days' do
+        let(:date) { 4.days.ago }
+
+        specify 'with a given start (:since option)' do
+          expect(playlist.views(since: date).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given end (:until option)' do
+          expect(playlist.views(until: date).keys.max).to eq date.to_date
+        end
+
+        specify 'with a given start (:from option)' do
+          expect(playlist.views(from: date).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given end (:to option)' do
+          expect(playlist.views(to: date).keys.max).to eq date.to_date
+        end
+      end
+
+      describe 'views can be grouped by day' do
+        let(:range) { {since: 4.days.ago.to_date, until: 3.days.ago.to_date} }
+        let(:keys) { range.values }
+
+        specify 'without a :by option (default)' do
+          views = playlist.views range
+          expect(views.keys).to eq range.values
+        end
+
+        specify 'with the :by option set to :day' do
+          views = playlist.views range.merge by: :day
+          expect(views.keys).to eq range.values
+        end
+      end
+
+      describe 'playlist starts can be retrieved for a specific day' do
+        context 'in which the playlist was viewed' do
+          let(:playlist_starts) { playlist.playlist_starts_on ENV['YT_TEST_PARTNER_PLAYLIST_DATE']}
+          it { expect(playlist_starts).to be_a Float }
+        end
+
+        context 'in which the playlist was not viewed' do
+          let(:playlist_starts) { playlist.playlist_starts_on 20.years.ago}
+          it { expect(playlist_starts).to be_nil }
+        end
+      end
+
+      describe 'playlist starts can be retrieved for a range of days' do
+        let(:date) { 4.days.ago }
+
+        specify 'with a given start (:since option)' do
+          expect(playlist.playlist_starts(since: date).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given end (:until option)' do
+          expect(playlist.playlist_starts(until: date).keys.max).to eq date.to_date
+        end
+
+        specify 'with a given start (:from option)' do
+          expect(playlist.playlist_starts(from: date).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given end (:to option)' do
+          expect(playlist.playlist_starts(to: date).keys.max).to eq date.to_date
+        end
+      end
+
+      describe 'playlist starts can be grouped by day' do
+        let(:range) { {since: 4.days.ago.to_date, until: 3.days.ago.to_date} }
+        let(:keys) { range.values }
+
+        specify 'without a :by option (default)' do
+          playlist_starts = playlist.playlist_starts range
+          expect(playlist_starts.keys).to eq range.values
+        end
+
+        specify 'with the :by option set to :day' do
+          playlist_starts = playlist.playlist_starts range.merge by: :day
+          expect(playlist_starts.keys).to eq range.values
+        end
+      end
+
+      describe 'average time in playlist can be retrieved for a specific day' do
+        context 'in which the playlist was viewed' do
+          let(:average_time_in_playlist) { playlist.average_time_in_playlist_on ENV['YT_TEST_PARTNER_PLAYLIST_DATE']}
+          it { expect(average_time_in_playlist).to be_a Float }
+        end
+
+        context 'in which the playlist was not viewed' do
+          let(:average_time_in_playlist) { playlist.average_time_in_playlist_on 20.years.ago}
+          it { expect(average_time_in_playlist).to be_nil }
+        end
+      end
+
+      describe 'average time in playlist can be retrieved for a range of days' do
+        let(:date) { 4.days.ago }
+
+        specify 'with a given start (:since option)' do
+          expect(playlist.average_time_in_playlist(since: date).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given end (:until option)' do
+          expect(playlist.average_time_in_playlist(until: date).keys.max).to eq date.to_date
+        end
+
+        specify 'with a given start (:from option)' do
+          expect(playlist.average_time_in_playlist(from: date).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given end (:to option)' do
+          expect(playlist.average_time_in_playlist(to: date).keys.max).to eq date.to_date
+        end
+      end
+
+      describe 'average time in playlist can be grouped by day' do
+        let(:range) { {since: 4.days.ago.to_date, until: 3.days.ago.to_date} }
+        let(:keys) { range.values }
+
+        specify 'without a :by option (default)' do
+          average_time_in_playlist = playlist.average_time_in_playlist range
+          expect(average_time_in_playlist.keys).to eq range.values
+        end
+
+        specify 'with the :by option set to :day' do
+          average_time_in_playlist = playlist.average_time_in_playlist range.merge by: :day
+          expect(average_time_in_playlist.keys).to eq range.values
+        end
+      end
+
+      describe 'views per playlist start can be retrieved for a specific day' do
+        context 'in which the playlist was viewed' do
+          let(:views_per_playlist_start) { playlist.views_per_playlist_start_on ENV['YT_TEST_PARTNER_PLAYLIST_DATE']}
+          it { expect(views_per_playlist_start).to be_a Float }
+        end
+
+        context 'in which the playlist was not viewed' do
+          let(:views_per_playlist_start) { playlist.views_per_playlist_start_on 20.years.ago}
+          it { expect(views_per_playlist_start).to be_nil }
+        end
+      end
+
+      describe 'views per playlist start can be retrieved for a range of days' do
+        let(:date) { 4.days.ago }
+
+        specify 'with a given start (:since option)' do
+          expect(playlist.views_per_playlist_start(since: date).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given end (:until option)' do
+          expect(playlist.views_per_playlist_start(until: date).keys.max).to eq date.to_date
+        end
+
+        specify 'with a given start (:from option)' do
+          expect(playlist.views_per_playlist_start(from: date).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given end (:to option)' do
+          expect(playlist.views_per_playlist_start(to: date).keys.max).to eq date.to_date
+        end
+      end
+
+      describe 'views per playlist start can be grouped by day' do
+        let(:range) { {since: 4.days.ago.to_date, until: 3.days.ago.to_date} }
+        let(:keys) { range.values }
+
+        specify 'without a :by option (default)' do
+          views_per_playlist_start = playlist.views_per_playlist_start range
+          expect(views_per_playlist_start.keys).to eq range.values
+        end
+
+        specify 'with the :by option set to :day' do
+          views_per_playlist_start = playlist.views_per_playlist_start range.merge by: :day
+          expect(views_per_playlist_start.keys).to eq range.values
+        end
+      end
+    end
+
+    context 'not managed by the authenticated Content Owner' do
+      let(:id) { 'PLbpi6ZahtOH6J5oPGySZcmbRfT7Hyq1sZ' }
+
+      specify 'playlist starts cannot be retrieved' do
+        expect{playlist.views}.to raise_error Yt::Errors::Forbidden
+        expect{playlist.playlist_starts}.to raise_error Yt::Errors::Forbidden
+        expect{playlist.average_time_in_playlist}.to raise_error Yt::Errors::Forbidden
+        expect{playlist.views_per_playlist_start}.to raise_error Yt::Errors::Forbidden
+      end
+    end
+  end
+end

data/spec/requests/as_content_owner/video_spec.rb

@@ -7,7 +7,7 @@ describe Yt::Video, :partner do
 
   context 'given a video of a partnered channel', :partner do
     context 'managed by the authenticated Content Owner' do
-      let(:id) { ENV['YT_TEST_VIDEO_CHANNEL_ID'] }
+      let(:id) { ENV['YT_TEST_PARTNER_VIDEO_ID'] }
 
       describe 'advertising options can be retrieved' do
         it { expect{video.advertising_options_set}.not_to raise_error }
@@ -478,6 +478,157 @@ describe Yt::Video, :partner do
         end
       end
 
+      describe 'estimated minutes watched can be retrieved for a specific day' do
+        context 'in which the video was partnered' do
+          let(:estimated_minutes_watched) { video.estimated_minutes_watched_on 5.days.ago}
+          it { expect(estimated_minutes_watched).to be_a Float }
+        end
+
+        context 'in which the video was not partnered' do
+          let(:estimated_minutes_watched) { video.estimated_minutes_watched_on 20.years.ago}
+          it { expect(estimated_minutes_watched).to be_nil }
+        end
+      end
+
+      describe 'estimated minutes watched can be retrieved for a range of days' do
+        let(:date) { 4.days.ago }
+
+        specify 'with a given start (:since option)' do
+          expect(video.estimated_minutes_watched(since: date).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given end (:until option)' do
+          expect(video.estimated_minutes_watched(until: date).keys.max).to eq date.to_date
+        end
+
+        specify 'with a given start (:from option)' do
+          expect(video.estimated_minutes_watched(from: date).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given end (:to option)' do
+          expect(video.estimated_minutes_watched(to: date).keys.max).to eq date.to_date
+        end
+      end
+
+      describe 'estimated minutes watched can be grouped by day' do
+        let(:range) { {since: 4.days.ago.to_date, until: 3.days.ago.to_date} }
+        let(:keys) { range.values }
+
+        specify 'without a :by option (default)' do
+          estimated_minutes_watched = video.estimated_minutes_watched range
+          expect(estimated_minutes_watched.keys).to eq range.values
+        end
+
+        specify 'with the :by option set to :day' do
+          estimated_minutes_watched = video.estimated_minutes_watched range.merge by: :day
+          expect(estimated_minutes_watched.keys).to eq range.values
+        end
+      end
+
+      describe 'estimated minutes watched can be grouped by traffic source' do
+        let(:range) { {since: 4.days.ago, until: 3.days.ago} }
+        let(:keys) { Yt::Collections::Reports::TRAFFIC_SOURCES.keys }
+
+        specify 'with the :by option set to :traffic_source' do
+          estimated_minutes_watched = video.estimated_minutes_watched range.merge by: :traffic_source
+          expect(estimated_minutes_watched.keys - keys).to be_empty
+        end
+      end
+
+      describe 'average view duration can be retrieved for a specific day' do
+        context 'in which the video was partnered' do
+          let(:average_view_duration) { video.average_view_duration_on 5.days.ago}
+          it { expect(average_view_duration).to be_a Float }
+        end
+
+        context 'in which the video was not partnered' do
+          let(:average_view_duration) { video.average_view_duration_on 20.years.ago}
+          it { expect(average_view_duration).to be_nil }
+        end
+      end
+
+      describe 'average view duration can be retrieved for a range of days' do
+        let(:date) { 4.days.ago }
+
+        specify 'with a given start (:since option)' do
+          expect(video.average_view_duration(since: date).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given end (:until option)' do
+          expect(video.average_view_duration(until: date).keys.max).to eq date.to_date
+        end
+
+        specify 'with a given start (:from option)' do
+          expect(video.average_view_duration(from: date).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given end (:to option)' do
+          expect(video.average_view_duration(to: date).keys.max).to eq date.to_date
+        end
+      end
+
+      describe 'average view duration can be grouped by day' do
+        let(:range) { {since: 4.days.ago.to_date, until: 3.days.ago.to_date} }
+        let(:keys) { range.values }
+
+        specify 'without a :by option (default)' do
+          average_view_duration = video.average_view_duration range
+          expect(average_view_duration.keys).to eq range.values
+        end
+
+        specify 'with the :by option set to :day' do
+          average_view_duration = video.average_view_duration range.merge by: :day
+          expect(average_view_duration.keys).to eq range.values
+        end
+      end
+
+      describe 'average view percentage can be retrieved for a specific day' do
+        context 'in which the video was partnered' do
+          let(:average_view_percentage) { video.average_view_percentage_on 5.days.ago}
+          it { expect(average_view_percentage).to be_a Float }
+        end
+
+        context 'in which the video was not partnered' do
+          let(:average_view_percentage) { video.average_view_percentage_on 20.years.ago}
+          it { expect(average_view_percentage).to be_nil }
+        end
+      end
+
+      describe 'average view percentage can be retrieved for a range of days' do
+        let(:date) { 4.days.ago }
+
+        specify 'with a given start (:since option)' do
+          expect(video.average_view_percentage(since: date).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given end (:until option)' do
+          expect(video.average_view_percentage(until: date).keys.max).to eq date.to_date
+        end
+
+        specify 'with a given start (:from option)' do
+          expect(video.average_view_percentage(from: date).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given end (:to option)' do
+          expect(video.average_view_percentage(to: date).keys.max).to eq date.to_date
+        end
+      end
+
+      describe 'average view percentage can be grouped by day' do
+        let(:range) { {since: 4.days.ago.to_date, until: 3.days.ago.to_date} }
+        let(:keys) { range.values }
+
+        specify 'without a :by option (default)' do
+          average_view_percentage = video.average_view_percentage range
+          expect(average_view_percentage.keys).to eq range.values
+        end
+
+        specify 'with the :by option set to :day' do
+          average_view_percentage = video.average_view_percentage range.merge by: :day
+          expect(average_view_percentage.keys).to eq range.values
+        end
+      end
+
       describe 'impressions can be retrieved for a specific day' do
         context 'in which the video was partnered' do
           let(:impressions) { video.impressions_on 20.days.ago}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yt
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.14.1
 platform: ruby
 authors:
 - Claudio Baccigalupo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-25 00:00:00.000000000 Z
+date: 2015-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -267,6 +267,7 @@ files:
 - spec/requests/as_content_owner/content_owner_spec.rb
 - spec/requests/as_content_owner/match_policy_spec.rb
 - spec/requests/as_content_owner/ownership_spec.rb
+- spec/requests/as_content_owner/playlist_spec.rb
 - spec/requests/as_content_owner/video_spec.rb
 - spec/requests/as_content_owner/viewer_percentages_spec.rb
 - spec/requests/as_server_app/channel_spec.rb
@@ -364,6 +365,7 @@ test_files:
 - spec/requests/as_content_owner/content_owner_spec.rb
 - spec/requests/as_content_owner/match_policy_spec.rb
 - spec/requests/as_content_owner/ownership_spec.rb
+- spec/requests/as_content_owner/playlist_spec.rb
 - spec/requests/as_content_owner/video_spec.rb
 - spec/requests/as_content_owner/viewer_percentages_spec.rb
 - spec/requests/as_server_app/channel_spec.rb