yt 0.13.10 → 0.13.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f38c80c9cc34b749849ed9934a037fe7707614ce
-  data.tar.gz: 2a9a06c9f14a9fabe19aa0d74e47e2a2fe2aaf6f
+  metadata.gz: 786cbb9164a2e2b754ce54f81a003d8fee3abc05
+  data.tar.gz: cdb45f6cb5c1dfc7a8241a9a75862513db54336d
 SHA512:
-  metadata.gz: d39da84ceb5bd9941ea7a90b32ca01e2c94d1aa101289ac7ff012728663f08279bf2d6e961761aeb3043f973fe9304109d4449b95c45e78126784bc7d278bdc4
-  data.tar.gz: fed816b3f0ef773b7b3f1050135c1a1e08b953ada0ba4aeafc69571c9e0f0408158190a20bcb4be0f4bca803a246254d2738502fed05ec4b4c61f512e09c585c
+  metadata.gz: c66811d1d74ee081d1fd00864c8668e1a053d6326892c6fd4d999524b913514cf2753f29c3926e2124a31505ecd9689a8e15fa660a5470af84f9b40468b50c18
+  data.tar.gz: 598db011f908c5d8200601abe755aea2571233c0d41fb5627397ea268efff5c8a2ab30d61e86f368ccc9a47f94f8888ff27eec66c6a6454f12cf8ad77233391d

data/CHANGELOG.md

@@ -6,7 +6,13 @@ For more information about changelogs, check
 [Keep a Changelog](http://keepachangelog.com) and
 [Vandamme](http://tech-angels.github.io/vandamme).
 
-## 0.13.9 - 2015-02-17
+## 0.13.11 - 2015-02-27
+
+* [FEATURE] New channel reports: `subscribers_gained`, `subscribers_lost`.
+* [FEATURE] New video reports: `subscribers_gained`, `subscribers_lost`.
+* [FEATURE] New channel reports: `estimated_minutes_watched`, `average_view_duration`, `average_view_percentage`.
+
+## 0.13.10 - 2015-02-17
 
 * [FEATURE] New `video.upload_thumbnail` to upload the thumbnail for a video.
 

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.9'
+    gem 'yt', '~> 0.13.11'
 
 Since the gem follows [Semantic Versioning](http://semver.org),
 indicating the full version in your Gemfile (~> *major*.*minor*.*patch*)
@@ -148,7 +148,7 @@ Use [Yt::Channel](http://rubydoc.info/github/Fullscreen/yt/master/Yt/Models/Chan
 * access the channels that the channel is subscribed to
 * subscribe to and unsubscribe from a channel
 * delete playlists from a channel
-* retrieve the daily earnings, views, comments, likes, dislikes, shares and impressions of a channel
+* retrieve the daily earnings, views, comments, likes, dislikes, shares, subscribers gained/lost, estimated/average video watch and impressions of a channel
 * retrieve the viewer percentage of a channel by gender and age group
 
 ```ruby
@@ -201,7 +201,11 @@ channel.comments until: 2.days.ago #=> {Wed, 28 May 2014 => 9.0, Thu, 29 May 201
 channel.likes from: 8.days.ago #=> {Tue, 27 May 2014 => 7.0, Wed, 28 May 2014 => 0.0, …}
 channel.dislikes to: 2.days.ago #=> {Tue, 27 May 2014 => 0.0, Wed, 28 May 2014 => 1.0, …}
 channel.shares since: 7.days.ago, until: 7.days.ago  #=> {Wed, 28 May 2014 => 3.0}
-
+channel.subscribers_gained from: '2014-08-30', to: '2014-08-31' #=> {Sat, 30 Aug 2014=>1.0, Sun, 31 Aug 2014=>0.0}
+channel.subscribers_lost from: '2014-08-30', to: '2014-08-31' #=> {Sat, 30 Aug 2014=>0.0, Sun, 31 Aug 2014=>0.0}
+channel.estimated_minutes_watched #=> {Sun, 22 Feb 2015=>2433258.0, Mon, 23 Feb 2015=>2634360.0, …}
+channel.average_view_duration #=>  {Sun, 22 Feb 2015=>329.0, Mon, 23 Feb 2015=>326.0, …}
+channel.average_view_percentage # {Sun, 22 Feb 2015=>38.858253094977265, Mon, 23 Feb 2015=>37.40014235438217, …}
 channel.viewer_percentages #=> {female: {'18-24' => 12.12, '25-34' => 16.16,…}…}
 channel.viewer_percentage(gender: :male) #=> 49.12
 ```
@@ -219,7 +223,11 @@ channel.likes from: 8.days.ago #=> {Tue, 27 May 2014 => 7.0, Wed, 28 May 2014 =>
 channel.dislikes to: 2.days.ago #=> {Tue, 27 May 2014 => 0.0, Wed, 28 May 2014 => 1.0, …}
 channel.shares since: 7.days.ago, until: 7.days.ago  #=> {Wed, 28 May 2014 => 3.0}
 channel.impressions_on 5.days.ago #=> 157.0
-
+channel.subscribers_gained from: '2014-08-30', to: '2014-08-31' #=> {Sat, 30 Aug 2014=>1.0, Sun, 31 Aug 2014=>0.0}
+channel.subscribers_lost from: '2014-08-30', to: '2014-08-31' #=> {Sat, 30 Aug 2014=>0.0, Sun, 31 Aug 2014=>0.0}
+channel.estimated_minutes_watched #=> {Sun, 22 Feb 2015=>2433258.0, Mon, 23 Feb 2015=>2634360.0, …}
+channel.average_view_duration #=>  {Sun, 22 Feb 2015=>329.0, Mon, 23 Feb 2015=>326.0, …}
+channel.average_view_percentage # {Sun, 22 Feb 2015=>38.858253094977265, Mon, 23 Feb 2015=>37.40014235438217, …}
 channel.viewer_percentages #=> {female: {'18-24' => 12.12, '25-34' => 16.16,…}…}
 channel.viewer_percentage(gender: :female) #=> 49.12
 
@@ -240,7 +248,7 @@ Use [Yt::Video](http://rubydoc.info/github/Fullscreen/yt/master/Yt/Models/Video)
 * access the annotations of a video
 * delete a video
 * like and dislike a video
-* retrieve the daily earnings, views, comments, likes, dislikes, shares, impressions and monetized playbacks of a video
+* retrieve the daily earnings, views, comments, likes, dislikes, shares, subscribers gained/lost, impressions and monetized playbacks of a video
 * retrieve the viewer percentage of a video by gender and age group
 * retrieve data about live-streaming videos
 * retrieve the advertising options of a video
@@ -331,7 +339,8 @@ video.comments until: 2.days.ago #=> {Wed, 28 May 2014 => 9.0, Thu, 29 May 2014
 video.likes from: 8.days.ago #=> {Tue, 27 May 2014 => 7.0, Wed, 28 May 2014 => 0.0, …}
 video.dislikes to: 2.days.ago #=> {Tue, 27 May 2014 => 0.0, Wed, 28 May 2014 => 1.0, …}
 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.viewer_percentages #=> {female: {'18-24' => 12.12, '25-34' => 16.16,…}…}
 video.viewer_percentage(gender: :female) #=> 49.12
 
@@ -350,6 +359,8 @@ video.comments until: 2.days.ago #=> {Wed, 28 May 2014 => 9.0, Thu, 29 May 2014
 video.likes from: 8.days.ago #=> {Tue, 27 May 2014 => 7.0, Wed, 28 May 2014 => 0.0, …}
 video.dislikes to: 2.days.ago #=> {Tue, 27 May 2014 => 0.0, Wed, 28 May 2014 => 1.0, …}
 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.impressions_on 5.days.ago #=> 157.0
 video.monetized_playbacks_on 5.days.ago #=> 123.0
 

data/lib/yt/models/channel.rb

@@ -31,6 +31,21 @@ module Yt
       # @macro has_report
       has_report :shares
 
+      # @macro has_report
+      has_report :subscribers_gained
+
+      # @macro has_report
+      has_report :subscribers_lost
+
+      # @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/models/video.rb

@@ -58,6 +58,16 @@ module Yt
       # @macro has_report
       has_report :shares
 
+      # @macro has_report
+      # @note: This is not the total number of subscribers gained by the video’s
+      #        channel, but the subscribers gained *from* the video’s page.
+      has_report :subscribers_gained
+
+      # @macro has_report
+      # @note: This is not the total number of subscribers lost by the video’s
+      #        channel, but the subscribers lost *from* the video’s page.
+      has_report :subscribers_lost
+
       # @macro has_report
       has_report :impressions
 

data/lib/yt/version.rb

@@ -1,3 +1,3 @@
 module Yt
-  VERSION = '0.13.10'
+  VERSION = '0.13.11'
 end

data/spec/requests/as_account/channel_spec.rb

@@ -130,6 +130,11 @@ describe Yt::Channel, :device_app do
       expect{channel.likes}.not_to raise_error
       expect{channel.dislikes}.not_to raise_error
       expect{channel.shares}.not_to raise_error
+      expect{channel.subscribers_gained}.not_to raise_error
+      expect{channel.subscribers_lost}.not_to raise_error
+      expect{channel.estimated_minutes_watched}.not_to raise_error
+      expect{channel.average_view_duration}.not_to raise_error
+      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
 
@@ -138,6 +143,11 @@ describe Yt::Channel, :device_app do
       expect{channel.likes_on 3.days.ago}.not_to raise_error
       expect{channel.dislikes_on 3.days.ago}.not_to raise_error
       expect{channel.shares_on 3.days.ago}.not_to raise_error
+      expect{channel.subscribers_gained_on 3.days.ago}.not_to raise_error
+      expect{channel.subscribers_lost_on 3.days.ago}.not_to raise_error
+      expect{channel.estimated_minutes_watched_on 3.days.ago}.not_to raise_error
+      expect{channel.average_view_duration_on 3.days.ago}.not_to raise_error
+      expect{channel.average_view_percentage_on 3.days.ago}.not_to raise_error
       expect{channel.earnings_on 3.days.ago}.to raise_error Yt::Errors::Unauthorized
       expect{channel.impressions_on 3.days.ago}.to raise_error Yt::Errors::Unauthorized
     end

data/spec/requests/as_account/video_spec.rb

@@ -285,6 +285,8 @@ describe Yt::Video, :device_app do
       expect{video.likes}.not_to raise_error
       expect{video.dislikes}.not_to raise_error
       expect{video.shares}.not_to raise_error
+      expect{video.subscribers_gained}.not_to raise_error
+      expect{video.subscribers_lost}.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
@@ -295,6 +297,8 @@ describe Yt::Video, :device_app do
       expect{video.likes_on 3.days.ago}.not_to raise_error
       expect{video.dislikes_on 3.days.ago}.not_to raise_error
       expect{video.shares_on 3.days.ago}.not_to raise_error
+      expect{video.subscribers_gained_on 3.days.ago}.not_to raise_error
+      expect{video.subscribers_lost_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

@@ -214,6 +214,166 @@ describe Yt::Channel, :partner do
         end
       end
 
+      describe 'gained subscribers can be retrieved for a specific day' do
+        context 'in which the channel was partnered' do
+          let(:subscribers_gained) { channel.subscribers_gained_on 5.days.ago}
+          it { expect(subscribers_gained).to be_a Float }
+        end
+
+        context 'in which the channel was not partnered' do
+          let(:subscribers_gained) { channel.subscribers_gained_on 20.years.ago}
+          it { expect(subscribers_gained).to be_nil }
+        end
+      end
+
+      describe 'gained subscribers can be retrieved for a range of days' do
+        let(:date) { 4.days.ago }
+
+        specify 'with a given start (:since option)' do
+          expect(channel.subscribers_gained(since: date).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given end (:until option)' do
+          expect(channel.subscribers_gained(until: date).keys.max).to eq date.to_date
+        end
+
+        specify 'with a given start (:from option)' do
+          expect(channel.subscribers_gained(from: date).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given end (:to option)' do
+          expect(channel.subscribers_gained(to: date).keys.max).to eq date.to_date
+        end
+      end
+
+      describe 'lost subscribers can be retrieved for a specific day' do
+        context 'in which the channel was partnered' do
+          let(:subscribers_lost) { channel.subscribers_lost_on 5.days.ago}
+          it { expect(subscribers_lost).to be_a Float }
+        end
+
+        context 'in which the channel was not partnered' do
+          let(:subscribers_lost) { channel.subscribers_lost_on 20.years.ago}
+          it { expect(subscribers_lost).to be_nil }
+        end
+      end
+
+      describe 'lost subscribers can be retrieved for a range of days' do
+        let(:date) { 4.days.ago }
+
+        specify 'with a given start (:since option)' do
+          expect(channel.subscribers_lost(since: date).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given end (:until option)' do
+          expect(channel.subscribers_lost(until: date).keys.max).to eq date.to_date
+        end
+
+        specify 'with a given start (:from option)' do
+          expect(channel.subscribers_lost(from: date).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given end (:to option)' do
+          expect(channel.subscribers_lost(to: date).keys.max).to eq date.to_date
+        end
+      end
+
+      describe 'estimated minutes watched can be retrieved for a specific day' do
+        context 'in which the channel was partnered' do
+          let(:estimated_minutes_watched) { channel.estimated_minutes_watched_on 5.days.ago}
+          it { expect(estimated_minutes_watched).to be_a Float }
+        end
+
+        context 'in which the channel was not partnered' do
+          let(:estimated_minutes_watched) { channel.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(channel.estimated_minutes_watched(since: date).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given end (:until option)' do
+          expect(channel.estimated_minutes_watched(until: date).keys.max).to eq date.to_date
+        end
+
+        specify 'with a given start (:from option)' do
+          expect(channel.estimated_minutes_watched(from: date).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given end (:to option)' do
+          expect(channel.estimated_minutes_watched(to: date).keys.max).to eq date.to_date
+        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}
+          it { expect(average_view_duration).to be_a Float }
+        end
+
+        context 'in which the channel was not partnered' do
+          let(:average_view_duration) { channel.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(channel.average_view_duration(since: date).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given end (:until option)' do
+          expect(channel.average_view_duration(until: date).keys.max).to eq date.to_date
+        end
+
+        specify 'with a given start (:from option)' do
+          expect(channel.average_view_duration(from: date).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given end (:to option)' do
+          expect(channel.average_view_duration(to: date).keys.max).to eq date.to_date
+        end
+      end
+
+      describe 'average view percentage can be retrieved for a specific day' do
+        context 'in which the channel was partnered' do
+          let(:average_view_percentage) { channel.average_view_percentage_on 5.days.ago}
+          it { expect(average_view_percentage).to be_a Float }
+        end
+
+        context 'in which the channel was not partnered' do
+          let(:average_view_percentage) { channel.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(channel.average_view_percentage(since: date).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given end (:until option)' do
+          expect(channel.average_view_percentage(until: date).keys.max).to eq date.to_date
+        end
+
+        specify 'with a given start (:from option)' do
+          expect(channel.average_view_percentage(from: date).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given end (:to option)' do
+          expect(channel.average_view_percentage(to: date).keys.max).to eq date.to_date
+        end
+      end
+
       describe 'impressions can be retrieved for a specific day' do
         context 'in which the channel was partnered' do
           let(:impressions) { channel.impressions_on 20.days.ago}

data/spec/requests/as_content_owner/video_spec.rb

@@ -205,6 +205,70 @@ describe Yt::Video, :partner do
         end
       end
 
+      describe 'gained subscribers can be retrieved for a specific day' do
+        context 'in which the video was partnered' do
+          let(:subscribers_gained) { video.subscribers_gained_on 5.days.ago}
+          it { expect(subscribers_gained).to be_a Float }
+        end
+
+        context 'in which the video was not partnered' do
+          let(:subscribers_gained) { video.subscribers_gained_on 20.years.ago}
+          it { expect(subscribers_gained).to be_nil }
+        end
+      end
+
+      describe 'gained subscribers can be retrieved for a range of days' do
+        let(:date) { 4.days.ago }
+
+        specify 'with a given start (:since option)' do
+          expect(video.subscribers_gained(since: date).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given end (:until option)' do
+          expect(video.subscribers_gained(until: date).keys.max).to eq date.to_date
+        end
+
+        specify 'with a given start (:from option)' do
+          expect(video.subscribers_gained(from: date).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given end (:to option)' do
+          expect(video.subscribers_gained(to: date).keys.max).to eq date.to_date
+        end
+      end
+
+      describe 'lost subscribers can be retrieved for a specific day' do
+        context 'in which the video was partnered' do
+          let(:subscribers_lost) { video.subscribers_lost_on 5.days.ago}
+          it { expect(subscribers_lost).to be_a Float }
+        end
+
+        context 'in which the video was not partnered' do
+          let(:subscribers_lost) { video.subscribers_lost_on 20.years.ago}
+          it { expect(subscribers_lost).to be_nil }
+        end
+      end
+
+      describe 'lost subscribers can be retrieved for a range of days' do
+        let(:date) { 4.days.ago }
+
+        specify 'with a given start (:since option)' do
+          expect(video.subscribers_lost(since: date).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given end (:until option)' do
+          expect(video.subscribers_lost(until: date).keys.max).to eq date.to_date
+        end
+
+        specify 'with a given start (:from option)' do
+          expect(video.subscribers_lost(from: date).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given end (:to option)' do
+          expect(video.subscribers_lost(to: date).keys.max).to eq date.to_date
+        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.13.10
+  version: 0.13.11
 platform: ruby
 authors:
 - Claudio Baccigalupo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-17 00:00:00.000000000 Z
+date: 2015-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport