yt 0.7.5 → 0.7.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d346ffef89d5b5f77243722480b4182d31d23a7f
-  data.tar.gz: 1148ab3e8561f75edba5cf62dad118d0e4fe255d
+  metadata.gz: 21e026d255684b3c18d8291bd4eeda02ff233f0c
+  data.tar.gz: 9af923985d7022b16b6d31b8483af39f617015bf
 SHA512:
-  metadata.gz: 7ab946dc91a6d0089042d33ada2939b0a8c6a2a8221360e3f9cd122c197cdf40835715d3b284b869c344de7af8260eaa305a83b76fddcff8fd29372dee876536
-  data.tar.gz: 1c9cbb659eddc7993dbd3f5c9e8206d2bed99639bfb189bf013565d7b9884773711e45f379f2ac491e3e92e4282a0b2b8b05d1692a6c8d4315d1997e433fcabb
+  metadata.gz: 0e8b1696e652a865442b0b604882293a9057fe193092167793da12e7a273e615605072b3eaffd3e661f2c65471c0ad6a958bbc21c61653e4aee3f05c4ebe904d
+  data.tar.gz: 90b38724c6349dfd14100bb3f4bf12bf2187d704ebd3c069acd5f6bfa6dc1e2772acaf8c1306483cde36e3a2fa1beaecde069e6f0917b44af503b7cc8c2dd2e4

data/.travis.yml

@@ -22,4 +22,5 @@ env:
   - secure: Ejj8tsuwyrRVmCc/R9ubKWCHWhCGpe0Dy6fc1UuPCkcMZyXq9ZC02v2obWsTQQ7epEgsCYZAO4v/gWpuv1b1huGcWdfJzMW7RCoY87cEf9HnAK0lSwGx4+/pYkEMe8y5p149C3vAR8nqczvEavN1fUq/WwPUqp+JyDP7kwFTs2Y=
   - secure: gE5kAT1R54hmS+W3YYGcUtlD8ZskvTctVR3sr+C5CUjVPdq6Ktx5Q/a6EJyAVVrhxpaCOuk3LG+VkzdQIVFUNRiDPcOulkond4HkSQDoy+IJ/wTXvUS+lIJ1ERUnWega+APrQUjH5s2WayPGZUBqWt/u8Tt9EmSUZfuKZSEXqZk=
   - secure: ZUx5v/wHW/TENg8NfFINiiMoe2D031ntDTiuIBdf88c/bMClkEtRRgomtK9RBkFonEyGEOkXxUm2SLzRf340V3eIXWQhil7ab1lcYs8X59aVS/NK/GqChH8Nia17gc3OTQ9k6rYvj4Lp60Dh9WG1cijLPd4/OvPmf6qX9uYfJMw=
-  - secure: DumQVO01Y3Ki1skuOYOZzosDb6jS0XyG1O8Agy3mVxXGJzQE+s1z2UFz4gMpsU9o/gmiNMddp7I6+RtbZjo9hN3H7vlRRwEeB7tuUMiDyomSx1FlHcCFfPdTmhxGg8X78SErMWqNC6eReGrCTgBdIq1ho7dIu53qJNxTEFqx7eI=
+  - secure: DumQVO01Y3Ki1skuOYOZzosDb6jS0XyG1O8Agy3mVxXGJzQE+s1z2UFz4gMpsU9o/gmiNMddp7I6+RtbZjo9hN3H7vlRRwEeB7tuUMiDyomSx1FlHcCFfPdTmhxGg8X78SErMWqNC6eReGrCTgBdIq1ho7dIu53qJNxTEFqx7eI=
+  - secure: UCceSRqPe5Y8WCM85qj0i8wlB5gJRSegJZfVj5jnwyermcOc1ZucwDZwTzkYVbLfDGTqTqzqW6M322a1tWm74xeIbxuHG7fw3Waoxk4zh3tg1CmNkzeDZFnl6V10uOMT6pn5E3kfhLzqOzftJN6fTMCgYMdkwJcfdrMX+z1cxwM=

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    yt (0.7.5)
+    yt (0.7.6)
       activesupport
 
 GEM

data/HISTORY.md

@@ -13,6 +13,7 @@ v0.7 - 2014/06/18
 * Extract Reports (earnings, views) into module with macro `has_report`
 * New channel reports: comments, likes, dislikes, shares and impressions
 * Allow both normal and partnered channels to retrieve reports about views, comments, likes, dislikes, shares
+* Make reports available also on Video (not just Channel)
 
 v0.6 - 2014/06/05
 -----------------

data/README.md

@@ -119,6 +119,13 @@ channel = Yt::Channel.new id: 'UCxO1tY8h1AhOz0T4ENwmpow', auth: account
 
 channel.subscribed? #=> false
 channel.subscribe #=> true
+```
+
+*The methods above require to be authenticated as a YouTube account (see below).*
+
+```ruby
+account = Yt::Account.new access_token: 'ya29.1.ABCDEFGHIJ'
+channel = Yt::Channel.new id: 'UCxO1tY8h1AhOz0T4ENwmpow', auth: account
 
 channel.create_playlist title: 'New playlist' #=> true
 channel.delete_playlists title: 'New playlist' #=> [true]
@@ -130,7 +137,7 @@ channel.dislikes to: 2.days.ago #=> {Tue, 27 May 2014 => 0.0, Wed, 28 May 2014 =
 channel.shares since: 7.days.ago, until: 7.days.ago  #=> {Wed, 28 May 2014 => 3.0}
 ```
 
-*The methods above require to be authenticated as a YouTube account (see below).*
+*The methods above require to be authenticated as the channel’s account (see below).*
 
 ```ruby
 content_owner = Yt::ContentOwner.new owner_name: 'CMSname', access_token: 'ya29.1.ABCDEFGHIJ'
@@ -156,6 +163,7 @@ Use [Yt::Video](http://rubydoc.info/github/Fullscreen/yt/master/Yt/Models/Video)
 * update the attributes of a video
 * access the annotations of a video
 * like and dislike a video
+* retrieve the daily earnings, views, comments, likes, dislikes, shares and impressions of a channel
 
 ```ruby
 video = Yt::Video.new id: 'MESycYJytkU'
@@ -195,11 +203,35 @@ video.like #=> true
 *The methods above require to be authenticated as a YouTube account (see below).*
 
 ```ruby
+account = Yt::Account.new access_token: 'ya29.1.ABCDEFGHIJ'
+video = Yt::Video.new id: 'MESycYJytkU', auth: account
+
 video.update title: 'A title', description: 'A description', tags: ['a tag'], categoryId: '21'
+
+video.views since: 7.days.ago #=> {Wed, 28 May 2014 => 12.0, Thu, 29 May 2014 => 3.0, …}
+video.comments until: 2.days.ago #=> {Wed, 28 May 2014 => 9.0, Thu, 29 May 2014 => 4.0, …}
+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}
 ```
 
 *The methods above require to be authenticated as the video’s owner (see below).*
 
+```ruby
+content_owner = Yt::ContentOwner.new owner_name: 'CMSname', access_token: 'ya29.1.ABCDEFGHIJ'
+video = Yt::Video.new id: 'MESycYJytkU', auth: content_owner
+
+video.earnings_on 5.days.ago #=> 12.23
+video.views since: 7.days.ago #=> {Wed, 28 May 2014 => 12.0, Thu, 29 May 2014 => 3.0, …}
+video.comments until: 2.days.ago #=> {Wed, 28 May 2014 => 9.0, Thu, 29 May 2014 => 4.0, …}
+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.impressions_on 5.days.ago #=> 157.0
+```
+
+*The methods above require to be authenticated as the video’s content owner (see below).*
+
 Yt::Playlist
 ------------
 
@@ -439,7 +471,7 @@ To install on your system, run
 
 To use inside a bundled Ruby project, add this line to the Gemfile:
 
-    gem 'yt', '~> 0.7.5'
+    gem 'yt', '~> 0.7.6'
 
 Since the gem follows [Semantic Versioning](http://semver.org),
 indicating the full version in your Gemfile (~> *major*.*minor*.*patch*)

data/lib/yt/models/video.rb

@@ -1,10 +1,14 @@
 require 'yt/models/resource'
+require 'yt/modules/reports'
 
 module Yt
   module Models
     # Provides methods to interact with YouTube videos.
     # @see https://developers.google.com/youtube/v3/docs/videos
     class Video < Resource
+      # Includes the +:has_report+ method to access YouTube Analytics reports.
+      extend Modules::Reports
+
       delegate :tags, :channel_id, :channel_title, :category_id,
         :live_broadcast_content, to: :snippet
 
@@ -22,6 +26,27 @@ module Yt
       #   @return [Yt::Collections::Annotations] the video’s annotations.
       has_many :annotations
 
+      # @macro has_report
+      has_report :earnings
+
+      # @macro has_report
+      has_report :views
+
+      # @macro has_report
+      has_report :comments
+
+      # @macro has_report
+      has_report :likes
+
+      # @macro has_report
+      has_report :dislikes
+
+      # @macro has_report
+      has_report :shares
+
+      # @macro has_report
+      has_report :impressions
+
       # @!attribute [r] statistics_set
       #   @return [Yt::Models::StatisticsSet] the statistics for the video.
       has_one :statistics_set
@@ -94,6 +119,21 @@ module Yt
         !liked?
       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'] = "video==#{id}"
+        end
+      end
+
     private
 
       # @return [Hash] the parameters to submit to YouTube to update a video.

data/lib/yt/version.rb

@@ -1,3 +1,3 @@
 module Yt
-  VERSION = '0.7.5'
+  VERSION = '0.7.6'
 end

data/spec/requests/as_account/channel_spec.rb

@@ -73,7 +73,7 @@ describe Yt::Channel, :device_app do
 
     it 'returns valid reports for channel-related metrics' do
       # Some reports are only available to Content Owners.
-      # See content ownere test for more details about what the methods return.
+      # See content owner test for more details about what the methods return.
       expect{channel.views}.not_to raise_error
       expect{channel.comments}.not_to raise_error
       expect{channel.likes}.not_to raise_error

data/spec/requests/as_account/video_spec.rb

@@ -58,7 +58,7 @@ describe Yt::Video, :device_app do
     it { expect{video.statistics_set}.to raise_error Yt::Errors::NoItems }
   end
 
-  context 'given one of my own videos that I want to update' do
+  context 'given one of my own videos' do
     let(:id) { $account.videos.first.id }
 
     describe 'updates the attributes that I specify explicitly' do
@@ -78,5 +78,26 @@ describe Yt::Video, :device_app do
       it { expect{video.update attrs}.not_to change{video.category_id} }
       it { expect{video.update attrs}.not_to change{video.privacy_status} }
     end
+
+
+    it 'returns valid reports for channel-related metrics' do
+      # Some reports are only available to Content Owners.
+      # See content ownere test for more details about what the methods return.
+      expect{video.views}.not_to raise_error
+      expect{video.comments}.not_to raise_error
+      expect{video.likes}.not_to raise_error
+      expect{video.dislikes}.not_to raise_error
+      expect{video.shares}.not_to raise_error
+      expect{video.earnings}.to raise_error Yt::Errors::Unauthorized
+      expect{video.impressions}.to raise_error Yt::Errors::Unauthorized
+
+      expect{video.views_on 3.days.ago}.not_to raise_error
+      expect{video.comments_on 3.days.ago}.not_to raise_error
+      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.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
   end
 end

data/spec/requests/as_content_owner/video_spec.rb

@@ -0,0 +1,237 @@
+# encoding: UTF-8
+require 'spec_helper'
+require 'yt/models/video'
+
+describe Yt::Video, :partner do
+  subject(:video) { Yt::Video.new id: id, auth: $content_owner }
+
+  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'] }
+
+      describe 'earnings can be retrieved for a specific day' do
+        context 'in which the video made any money' do
+          let(:earnings) {video.earnings_on 5.days.ago}
+          it { expect(earnings).to be_a Float }
+        end
+
+        context 'in the future' do
+          let(:earnings) { video.earnings_on 5.days.from_now}
+          it { expect(earnings).to be_nil }
+        end
+      end
+
+      describe 'earnings can be retrieved for a range of days' do
+        let(:date) { 4.days.ago }
+
+        specify 'with a given start (:since option)' do
+          expect(video.earnings(since: date).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given end (:until option)' do
+          expect(video.earnings(until: date).keys.max).to eq date.to_date
+        end
+
+        specify 'with a given start (:from option)' do
+          expect(video.earnings(from: date).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given end (:to option)' do
+          expect(video.earnings(to: date).keys.max).to eq date.to_date
+        end
+      end
+
+      describe 'views can be retrieved for a specific day' do
+        context 'in which the video was partnered' do
+          let(:views) { video.views_on 5.days.ago}
+          it { expect(views).to be_a Float }
+        end
+
+        context 'in which the video was not partnered' do
+          let(:views) { video.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(video.views(since: date).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given end (:until option)' do
+          expect(video.views(until: date).keys.max).to eq date.to_date
+        end
+
+        specify 'with a given start (:from option)' do
+          expect(video.views(from: date).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given end (:to option)' do
+          expect(video.views(to: date).keys.max).to eq date.to_date
+        end
+      end
+
+      describe 'comments can be retrieved for a specific day' do
+        context 'in which the video was partnered' do
+          let(:comments) { video.comments_on 5.days.ago}
+          it { expect(comments).to be_a Float }
+        end
+
+        context 'in which the video was not partnered' do
+          let(:comments) { video.comments_on 20.years.ago}
+          it { expect(comments).to be_nil }
+        end
+      end
+
+      describe 'comments can be retrieved for a range of days' do
+        let(:date) { 4.days.ago }
+
+        specify 'with a given start (:since option)' do
+          expect(video.comments(since: date).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given end (:until option)' do
+          expect(video.comments(until: date).keys.max).to eq date.to_date
+        end
+
+        specify 'with a given start (:from option)' do
+          expect(video.comments(from: date).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given end (:to option)' do
+          expect(video.comments(to: date).keys.max).to eq date.to_date
+        end
+      end
+
+      describe 'likes can be retrieved for a specific day' do
+        context 'in which the video was partnered' do
+          let(:likes) { video.likes_on 5.days.ago}
+          it { expect(likes).to be_a Float }
+        end
+
+        context 'in which the video was not partnered' do
+          let(:likes) { video.likes_on 20.years.ago}
+          it { expect(likes).to be_nil }
+        end
+      end
+
+      describe 'likes can be retrieved for a range of days' do
+        let(:date) { 4.days.ago }
+
+        specify 'with a given start (:since option)' do
+          expect(video.likes(since: date).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given end (:until option)' do
+          expect(video.likes(until: date).keys.max).to eq date.to_date
+        end
+
+        specify 'with a given start (:from option)' do
+          expect(video.likes(from: date).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given end (:to option)' do
+          expect(video.likes(to: date).keys.max).to eq date.to_date
+        end
+      end
+
+      describe 'dislikes can be retrieved for a specific day' do
+        context 'in which the video was partnered' do
+          let(:dislikes) { video.dislikes_on 5.days.ago}
+          it { expect(dislikes).to be_a Float }
+        end
+
+        context 'in which the video was not partnered' do
+          let(:dislikes) { video.dislikes_on 20.years.ago}
+          it { expect(dislikes).to be_nil }
+        end
+      end
+
+      describe 'dislikes can be retrieved for a range of days' do
+        let(:date) { 4.days.ago }
+
+        specify 'with a given start (:since option)' do
+          expect(video.dislikes(since: date).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given end (:until option)' do
+          expect(video.dislikes(until: date).keys.max).to eq date.to_date
+        end
+
+        specify 'with a given start (:from option)' do
+          expect(video.dislikes(from: date).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given end (:to option)' do
+          expect(video.dislikes(to: date).keys.max).to eq date.to_date
+        end
+      end
+
+      describe 'shares can be retrieved for a specific day' do
+        context 'in which the video was partnered' do
+          let(:shares) { video.shares_on 5.days.ago}
+          it { expect(shares).to be_a Float }
+        end
+
+        context 'in which the video was not partnered' do
+          let(:shares) { video.shares_on 20.years.ago}
+          it { expect(shares).to be_nil }
+        end
+      end
+
+      describe 'shares can be retrieved for a range of days' do
+        let(:date) { 4.days.ago }
+
+        specify 'with a given start (:since option)' do
+          expect(video.shares(since: date).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given end (:until option)' do
+          expect(video.shares(until: date).keys.max).to eq date.to_date
+        end
+
+        specify 'with a given start (:from option)' do
+          expect(video.shares(from: date).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given end (:to option)' do
+          expect(video.shares(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 5.days.ago}
+          it { expect(impressions).to be_a Float }
+        end
+
+        context 'in which the video was not partnered' do
+          let(:impressions) { video.impressions_on 20.years.ago}
+          it { expect(impressions).to be_nil }
+        end
+      end
+
+      describe 'impressions can be retrieved for a range of days' do
+        let(:date) { 4.days.ago }
+
+        specify 'with a given start (:since option)' do
+          expect(video.impressions(since: date).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given end (:until option)' do
+          expect(video.impressions(until: date).keys.max).to eq date.to_date
+        end
+
+        specify 'with a given start (:from option)' do
+          expect(video.impressions(from: date).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given end (:to option)' do
+          expect(video.impressions(to: date).keys.max).to eq date.to_date
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yt
 version: !ruby/object:Gem::Version
-  version: 0.7.5
+  version: 0.7.6
 platform: ruby
 authors:
 - Claudio Baccigalupo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-26 00:00:00.000000000 Z
+date: 2014-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -211,6 +211,7 @@ files:
 - spec/requests/as_account/video_spec.rb
 - spec/requests/as_content_owner/channel_spec.rb
 - spec/requests/as_content_owner/content_owner_spec.rb
+- spec/requests/as_content_owner/video_spec.rb
 - spec/requests/as_server_app/channel_spec.rb
 - spec/requests/as_server_app/playlist_item_spec.rb
 - spec/requests/as_server_app/playlist_spec.rb
@@ -287,6 +288,7 @@ test_files:
 - spec/requests/as_account/video_spec.rb
 - spec/requests/as_content_owner/channel_spec.rb
 - spec/requests/as_content_owner/content_owner_spec.rb
+- spec/requests/as_content_owner/video_spec.rb
 - spec/requests/as_server_app/channel_spec.rb
 - spec/requests/as_server_app/playlist_item_spec.rb
 - spec/requests/as_server_app/playlist_spec.rb