yt 0.23.2 → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa3a856cfe1b488850e6af5bf28d463fda5b1dde
-  data.tar.gz: 65d075b87a03e753b232d923966fb12b0a947d7e
+  metadata.gz: f8721162ba728a25aa9a61c6d2ba3072fb3facad
+  data.tar.gz: 425cfa108f9ac55f82794e8d54c701713af6e7ca
 SHA512:
-  metadata.gz: aeee94c2369c21e724f251f013b049c300350b476f884deffde9252f422af8764670137bc52439993cf8d36c7203e4b75e1f7e9eaaba6227a0309a8befc5561b
-  data.tar.gz: a95ae747c8b4dc774a7e6c498355bb0019806360ab85bbef9da91fffc56c2e9afa4a7c81fece144a21504db5ec1e5e59686bf6b38ff796de39cbee31829f3339
+  metadata.gz: 774ce5a0883ffa386db4329ede3e5e078bd1bfcd2b248791ee738c0b5a33404db56f60868a29214d473ab96a2129101e4988902bb39e0a82752caf1af4addcaf
+  data.tar.gz: 6a90e32f14edea3ce523c3e66bd7f5b8e7a7c073d2efa76595975ef22df86776b191a4279c6c5eb8c5f20b2f58abd28e790988efbec128c0a85dec68153bd783

data/CHANGELOG.md

@@ -6,6 +6,19 @@ For more information about changelogs, check
 [Keep a Changelog](http://keepachangelog.com) and
 [Vandamme](http://tech-angels.github.io/vandamme).
 
+## 0.24.0 - 2015-05-21
+
+**How to upgrade**
+
+If your code expects the `estimated_minutes_watched`
+or the `average_view_duration` report to return a `Float`, beware that they now
+return an `Integer` (since that is what YouTube returns).
+In case you still need to parse a float, just append `.to_f` to the result.
+
+* [ENHANCEMENT] Return Integer on `estimated_minutes_watched` reports
+* [ENHANCEMENT] Return Integer on `average_view_duration` reports
+* [FEATURE] New `by: :referrer` option for reports.
+
 ## 0.23.2 - 2015-05-20
 
 * [FEATURE] Accept `:includes` in reports by video, related video and playlist to preload parts.

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.23.2'
+    gem 'yt', '~> 0.24.0'
 
 Since the gem follows [Semantic Versioning](http://semver.org),
 indicating the full version in your Gemfile (~> *major*.*minor*.*patch*)

data/lib/yt/associations/has_reports.rb

@@ -18,7 +18,7 @@ module Yt
       #   @return [Hash<Symbol, Hash>] the reports for each metric specified.
       #   @example Get the views and estimated minutes watched by day for last week:
       #     resource.reports only: [:views, :estimated_minutes_watched] since: 1.week.ago, by: :day
-      #     # => {views: {Wed, 8 May 2014 => 12, Thu, 9 May 2014 => 34, …}, estimated_minutes_watched: {Wed, 8 May 2014 => 9.0, Thu, 9 May 2014 => 6.0, …}}
+      #     # => {views: {Wed, 8 May 2014 => 12, Thu, 9 May 2014 => 34, …}, estimated_minutes_watched: {Wed, 8 May 2014 => 9, Thu, 9 May 2014 => 6, …}}
 
       # @!macro [new] report
       #   Returns the $1 grouped by the given dimension.
@@ -105,6 +105,11 @@ module Yt
       #     # => {"fullscreen" => 33.0, "good music" => 12.0, …}
       #   @return [Hash<String, $2>] if grouped by search term, the
       #     $1 for each search term that led viewers to the content.
+      #   @example Get yesterday’s $1 by URL that referred to the resource:
+      #     resource.$1 since: 1.day.ago, until: 1.day.ago, by: :referrer
+      #     # => {"Google Search" => 33.0, "ytimg.com" => 12.0, …}
+      #   @return [Hash<String, $2>] if grouped by search term, the
+      #     $1 for each search term that led viewers to the content.
       #   @example Get yesterday’s $1 by device type:
       #     resource.$1 since: 1.day.ago, until: 1.day.ago, by: :device_type
       #     # => {mobile: 133.0, tv: 412.0, …}

data/lib/yt/collections/reports.rb

@@ -12,6 +12,7 @@ module Yt
         hash[:embedded_player_location] = {name: 'insightPlaybackLocationDetail', parse: ->(url, *values) {@metrics.keys.zip(values.map{|v| {url => v}}).to_h} }
         hash[:related_video] = {name: 'insightTrafficSourceDetail', parse: ->(video_id, *values) { @metrics.keys.zip(values.map{|v| {video_id => v}}).to_h} }
         hash[:search_term] = {name: 'insightTrafficSourceDetail', parse: ->(search_term, *values) {@metrics.keys.zip(values.map{|v| {search_term => v}}).to_h} }
+        hash[:referrer] = {name: 'insightTrafficSourceDetail', parse: ->(url, *values) {@metrics.keys.zip(values.map{|v| {url => v}}).to_h} }
         hash[:video] = {name: 'video', parse: ->(video_id, *values) { @metrics.keys.zip(values.map{|v| {video_id => v}}).to_h} }
         hash[:playlist] = {name: 'playlist', parse: ->(playlist_id, *values) { @metrics.keys.zip(values.map{|v| {playlist_id => v}}).to_h} }
         hash[:device_type] = {name: 'deviceType', parse: ->(type, *values) {@metrics.keys.zip(values.map{|v| {type.downcase.to_sym => v}}).to_h} }
@@ -115,8 +116,8 @@ module Yt
           params['dimensions'] = DIMENSIONS[@dimension][:name] unless @dimension == :range
           params['max-results'] = 10 if @dimension == :video
           params['max-results'] = 200 if @dimension == :playlist
-          params['max-results'] = 25 if @dimension.in? [:embedded_player_location, :related_video, :search_term]
-          params['sort'] = "-#{@metrics.keys.join(',').to_s.camelize(:lower)}" if @dimension.in? [:video, :playlist, :embedded_player_location, :related_video, :search_term]
+          params['max-results'] = 25 if @dimension.in? [:embedded_player_location, :related_video, :search_term, :referrer]
+          params['sort'] = "-#{@metrics.keys.join(',').to_s.camelize(:lower)}" if @dimension.in? [:video, :playlist, :embedded_player_location, :related_video, :search_term, :referrer]
           params[:filters] = ((params[:filters] || '').split(';') + ["country==US"]).compact.uniq.join(';') if @dimension == :state && !@state
           params[:filters] = ((params[:filters] || '').split(';') + ["country==#{@country}"]).compact.uniq.join(';') if @country && !@state
           params[:filters] = ((params[:filters] || '').split(';') + ["province==US-#{@state}"]).compact.uniq.join(';') if @state
@@ -124,6 +125,7 @@ module Yt
           params[:filters] = ((params[:filters] || '').split(';') + ['insightPlaybackLocationType==EMBEDDED']).compact.uniq.join(';') if @dimension == :embedded_player_location
           params[:filters] = ((params[:filters] || '').split(';') + ['insightTrafficSourceType==RELATED_VIDEO']).compact.uniq.join(';') if @dimension == :related_video
           params[:filters] = ((params[:filters] || '').split(';') + ['insightTrafficSourceType==YT_SEARCH']).compact.uniq.join(';') if @dimension == :search_term
+          params[:filters] = ((params[:filters] || '').split(';') + ['insightTrafficSourceType==EXT_URL']).compact.uniq.join(';') if @dimension == :referrer
         end
       end
 

data/lib/yt/models/channel.rb

@@ -112,7 +112,7 @@ module Yt
       has_report :uniques, Integer
 
       # @macro report_by_channel_dimensions
-      has_report :estimated_minutes_watched, Float
+      has_report :estimated_minutes_watched, Integer
 
       # @macro report_by_gender_and_age_group
       has_report :viewer_percentage, Float
@@ -142,7 +142,7 @@ module Yt
       has_report :favorites_removed, Integer
 
       # @macro report_by_day_and_state
-      has_report :average_view_duration, Float
+      has_report :average_view_duration, Integer
 
       # @macro report_by_day_and_state
       has_report :average_view_percentage, Float

data/lib/yt/models/playlist.rb

@@ -157,13 +157,13 @@ module Yt
       has_report :views, Integer
 
       # @macro report_by_playlist_dimensions
-      has_report :estimated_minutes_watched, Float
+      has_report :estimated_minutes_watched, Integer
 
       # @macro report_by_gender_and_age_group
       has_report :viewer_percentage, Float
 
       # @macro report_by_day_and_state
-      has_report :average_view_duration, Float
+      has_report :average_view_duration, Integer
 
       # @macro report_by_day_and_state
       has_report :playlist_starts, Integer

data/lib/yt/models/video.rb

@@ -381,7 +381,7 @@ module Yt
       has_report :uniques, Integer
 
       # @macro report_by_video_dimensions
-      has_report :estimated_minutes_watched, Float
+      has_report :estimated_minutes_watched, Integer
 
       # @macro report_by_gender_and_age_group
       has_report :viewer_percentage, Float
@@ -415,7 +415,7 @@ module Yt
       has_report :favorites_removed, Integer
 
       # @macro report_by_day_and_state
-      has_report :average_view_duration, Float
+      has_report :average_view_duration, Integer
 
       # @macro report_by_day_and_state
       has_report :average_view_percentage, Float

data/lib/yt/version.rb

@@ -1,3 +1,3 @@
 module Yt
-  VERSION = '0.23.2'
+  VERSION = '0.24.0'
 end

data/spec/requests/as_content_owner/channel_spec.rb

@@ -12,10 +12,10 @@ describe Yt::Channel, :partner do
 
       describe 'multiple reports can be retrieved at once' do
         metrics = {views: Integer, uniques: Integer,
-          estimated_minutes_watched: Float, comments: Integer, likes: Integer,
+          estimated_minutes_watched: Integer, comments: Integer, likes: Integer,
           dislikes: Integer, shares: Integer, subscribers_gained: Integer,
           subscribers_lost: Integer, favorites_added: Integer,
-          favorites_removed: Integer, average_view_duration: Float,
+          favorites_removed: Integer, average_view_duration: Integer,
           average_view_percentage: Float, annotation_clicks: Integer,
           annotation_click_through_rate: Float,
           annotation_close_rate: Float, earnings: Float, impressions: Integer,
@@ -89,7 +89,7 @@ describe Yt::Channel, :partner do
 
       {views: Integer, comments: Integer, likes: Integer, dislikes: Integer,
        subscribers_gained: Integer, subscribers_lost: Integer,
-       estimated_minutes_watched: Float, average_view_duration: Float,
+       estimated_minutes_watched: Integer, average_view_duration: Integer,
        annotation_clicks: Integer, annotation_click_through_rate: Float,
        favorites_added: Integer, favorites_removed: Integer,
        average_view_percentage: Float, impressions: Integer,
@@ -347,6 +347,15 @@ describe Yt::Channel, :partner do
         end
       end
 
+      describe 'views can be grouped by referrer' do
+        let(:range) { {since: 4.days.ago, until: 3.days.ago} }
+
+        specify 'with the :by option set to :referrer' do
+          views = channel.views range.merge by: :referrer
+          expect(views.keys).to all(be_a String)
+        end
+      end
+
       describe 'views can be grouped by video' do
         let(:range) { {since: 4.days.ago, until: 3.days.ago} }
 
@@ -1024,6 +1033,15 @@ describe Yt::Channel, :partner do
         end
       end
 
+      describe 'estimated minutes watched can be grouped by referrer' do
+        let(:range) { {since: 4.days.ago, until: 3.days.ago} }
+
+        specify 'with the :by option set to :referrer' do
+          estimated_minutes_watched = channel.estimated_minutes_watched range.merge by: :referrer
+          expect(estimated_minutes_watched.keys).to all(be_a String)
+        end
+      end
+
       describe 'estimated minutes watched can be grouped by video' do
         let(:range) { {since: 4.days.ago, until: 3.days.ago} }
 
@@ -1048,7 +1066,7 @@ describe Yt::Channel, :partner do
         specify 'with the :by option set to :device_type' do
           estimated_minutes_watched = channel.estimated_minutes_watched range.merge by: :device_type
           expect(estimated_minutes_watched.keys).to all(be_instance_of Symbol)
-          expect(estimated_minutes_watched.values).to all(be_instance_of Float)
+          expect(estimated_minutes_watched.values).to all(be_an Integer)
         end
       end
 
@@ -1059,7 +1077,7 @@ describe Yt::Channel, :partner do
           minutes = channel.estimated_minutes_watched range.merge by: :country
           expect(minutes.keys).to all(be_a String)
           expect(minutes.keys.map(&:length).uniq).to eq [2]
-          expect(minutes.values).to all(be_a Float)
+          expect(minutes.values).to all(be_an Integer)
         end
       end
 
@@ -1070,7 +1088,7 @@ describe Yt::Channel, :partner do
           minutes = channel.estimated_minutes_watched range.merge by: :state
           expect(minutes.keys).to all(be_a String)
           expect(minutes.keys.map(&:length).uniq).to eq [2]
-          expect(minutes.values).to all(be_a Float)
+          expect(minutes.values).to all(be_an Integer)
         end
       end
 
@@ -1159,7 +1177,7 @@ describe Yt::Channel, :partner do
           duration = channel.average_view_duration range.merge by: :country
           expect(duration.keys).to all(be_a String)
           expect(duration.keys.map(&:length).uniq).to eq [2]
-          expect(duration.values).to all(be_a Float)
+          expect(duration.values).to all(be_an Integer)
         end
       end
 
@@ -1170,7 +1188,7 @@ describe Yt::Channel, :partner do
           duration = channel.average_view_duration range.merge by: :state
           expect(duration.keys).to all(be_a String)
           expect(duration.keys.map(&:length).uniq).to eq [2]
-          expect(duration.values).to all(be_a Float)
+          expect(duration.values).to all(be_an Integer)
         end
       end
 

data/spec/requests/as_content_owner/playlist_spec.rb

@@ -11,8 +11,8 @@ describe Yt::Playlist, :partner do
       let(:id) { ENV['YT_TEST_PARTNER_PLAYLIST_ID'] }
 
       describe 'multiple reports can be retrieved at once' do
-        metrics = {views: Integer, estimated_minutes_watched: Float,
-         average_view_duration: Float, playlist_starts: Integer,
+        metrics = {views: Integer, estimated_minutes_watched: Integer,
+         average_view_duration: Integer, playlist_starts: Integer,
          average_time_in_playlist: Float, views_per_playlist_start: Float}
 
         specify 'by day' do
@@ -37,8 +37,9 @@ describe Yt::Playlist, :partner do
         end
       end
 
-      {views: Integer, estimated_minutes_watched: Float, average_view_duration: Float,
-       playlist_starts: Integer, average_time_in_playlist: Float,
+      {views: Integer, estimated_minutes_watched: Integer,
+       average_view_duration: Integer, playlist_starts: Integer,
+       average_time_in_playlist: Float,
        views_per_playlist_start: Float}.each do |metric, type|
         describe "#{metric} can be retrieved for a range of days" do
           let(:date_in) { ENV['YT_TEST_PARTNER_VIDEO_DATE'] }
@@ -226,6 +227,15 @@ describe Yt::Playlist, :partner do
         end
       end
 
+      describe 'views can be grouped by referrer' do
+        let(:range) { {since: ENV['YT_TEST_PARTNER_PLAYLIST_DATE']} }
+
+        specify 'with the :by option set to :referrer' do
+          views = playlist.views range.merge by: :referrer
+          expect(views.keys).to all(be_a String)
+        end
+      end
+
       describe 'views can be grouped by video' do
         let(:range) { {since: 4.days.ago, until: 3.days.ago} }
 
@@ -358,6 +368,15 @@ describe Yt::Playlist, :partner do
         end
       end
 
+      describe 'estimated minutes watched can be grouped by referrer' do
+        let(:range) { {since: ENV['YT_TEST_PARTNER_PLAYLIST_DATE']} }
+
+        specify 'with the :by option set to :referrer' do
+          minutes = playlist.estimated_minutes_watched range.merge by: :referrer
+          expect(minutes.keys).to all(be_a String)
+        end
+      end
+
       describe 'estimated minutes watched can be grouped by video' do
         let(:range) { {since: 4.days.ago, until: 3.days.ago} }
 
@@ -382,7 +401,7 @@ describe Yt::Playlist, :partner do
         specify 'with the :by option set to :device_type' do
           minutes = playlist.estimated_minutes_watched range.merge by: :device_type
           expect(minutes.keys).to all(be_instance_of Symbol)
-          expect(minutes.values).to all(be_instance_of Float)
+          expect(minutes.values).to all(be_an Integer)
         end
       end
 
@@ -393,7 +412,7 @@ describe Yt::Playlist, :partner do
           minutes = playlist.estimated_minutes_watched range.merge by: :country
           expect(minutes.keys).to all(be_a String)
           expect(minutes.keys.map(&:length).uniq).to eq [2]
-          expect(minutes.values).to all(be_a Float)
+          expect(minutes.values).to all(be_an Integer)
         end
       end
 
@@ -404,7 +423,7 @@ describe Yt::Playlist, :partner do
           minutes = playlist.estimated_minutes_watched range.merge by: :state
           expect(minutes.keys).to all(be_a String)
           expect(minutes.keys.map(&:length).uniq).to eq [2]
-          expect(minutes.values).to all(be_a Float)
+          expect(minutes.values).to all(be_an Integer)
         end
       end
 
@@ -511,7 +530,7 @@ describe Yt::Playlist, :partner do
           duration = playlist.average_view_duration range.merge by: :country
           expect(duration.keys).to all(be_a String)
           expect(duration.keys.map(&:length).uniq).to eq [2]
-          expect(duration.values).to all(be_a Float)
+          expect(duration.values).to all(be_an Integer)
         end
       end
 
@@ -522,7 +541,7 @@ describe Yt::Playlist, :partner do
           duration = playlist.average_view_duration range.merge by: :state
           expect(duration.keys).to all(be_a String)
           expect(duration.keys.map(&:length).uniq).to eq [2]
-          expect(duration.values).to all(be_a Float)
+          expect(duration.values).to all(be_an Integer)
         end
       end
 

data/spec/requests/as_content_owner/video_spec.rb

@@ -76,7 +76,7 @@ describe Yt::Video, :partner do
       end
 
       {views: Integer, comments: Integer, dislikes: Integer,
-       estimated_minutes_watched: Float, average_view_duration: Float,
+       estimated_minutes_watched: Integer, average_view_duration: Integer,
        average_view_percentage: Float, impressions: Integer,
        subscribers_lost: Integer, subscribers_gained: Integer, likes: Integer,
        monetized_playbacks: Integer, earnings: Float}.each do |metric, type|
@@ -99,7 +99,7 @@ describe Yt::Video, :partner do
       {views: Integer, comments: Integer, likes: Integer, dislikes: Integer,
        shares: Integer, subscribers_gained: Integer, subscribers_lost: Integer,
        favorites_added: Integer,
-       estimated_minutes_watched: Float, average_view_duration: Float,
+       estimated_minutes_watched: Integer, average_view_duration: Integer,
        average_view_percentage: Float, impressions: Integer,
        monetized_playbacks: Integer, annotation_clicks: Integer,
        annotation_click_through_rate: Float, annotation_close_rate: Float,
@@ -196,10 +196,10 @@ describe Yt::Video, :partner do
 
       describe 'multiple reports can be retrieved at once' do
         metrics = {views: Integer, uniques: Integer,
-          estimated_minutes_watched: Float, comments: Integer, likes: Integer,
+          estimated_minutes_watched: Integer, comments: Integer, likes: Integer,
           dislikes: Integer, shares: Integer, subscribers_gained: Integer,
           subscribers_lost: Integer, favorites_added: Integer,
-          favorites_removed: Integer, average_view_duration: Float,
+          favorites_removed: Integer, average_view_duration: Integer,
           average_view_percentage: Float, annotation_clicks: Integer,
           annotation_click_through_rate: Float,
           annotation_close_rate: Float, earnings: Float, impressions: Integer,
@@ -339,6 +339,15 @@ describe Yt::Video, :partner do
         end
       end
 
+      describe 'views can be grouped by referrer' do
+        let(:range) { {since: ENV['YT_TEST_PARTNER_VIDEO_DATE']} }
+
+        specify 'with the :by option set to :referrer' do
+          views = video.views range.merge by: :referrer
+          expect(views.keys).to all(be_a String)
+        end
+      end
+
       describe 'views can be grouped by device type' do
         let(:range) { {since: ENV['YT_TEST_PARTNER_VIDEO_DATE']} }
 
@@ -661,13 +670,22 @@ describe Yt::Video, :partner do
         end
       end
 
+      describe 'estimated minutes watched can be grouped by referrer' do
+        let(:range) { {since: 4.days.ago, until: 3.days.ago} }
+
+        specify 'with the :by option set to :referrer' do
+          estimated_minutes_watched = video.estimated_minutes_watched range.merge by: :referrer
+          expect(estimated_minutes_watched.keys).to all(be_a String)
+        end
+      end
+
       describe 'estimated minutes watched can be grouped by device type' do
         let(:range) { {since: 4.days.ago, until: 3.days.ago} }
 
         specify 'with the :by option set to :device_type' do
           estimated_minutes_watched = video.estimated_minutes_watched range.merge by: :device_type
           expect(estimated_minutes_watched.keys).to all(be_instance_of Symbol)
-          expect(estimated_minutes_watched.values).to all(be_instance_of Float)
+          expect(estimated_minutes_watched.values).to all(be_an Integer)
         end
       end
 
@@ -678,7 +696,7 @@ describe Yt::Video, :partner do
           minutes = video.estimated_minutes_watched range.merge by: :country
           expect(minutes.keys).to all(be_a String)
           expect(minutes.keys.map(&:length).uniq).to eq [2]
-          expect(minutes.values).to all(be_a Float)
+          expect(minutes.values).to all(be_an Integer)
         end
       end
 
@@ -689,7 +707,7 @@ describe Yt::Video, :partner do
           minutes = video.estimated_minutes_watched range.merge by: :state
           expect(minutes.keys).to all(be_a String)
           expect(minutes.keys.map(&:length).uniq).to eq [2]
-          expect(minutes.values).to all(be_a Float)
+          expect(minutes.values).to all(be_an Integer)
         end
       end
 
@@ -744,7 +762,7 @@ describe Yt::Video, :partner do
           duration = video.average_view_duration range.merge by: :country
           expect(duration.keys).to all(be_a String)
           expect(duration.keys.map(&:length).uniq).to eq [2]
-          expect(duration.values).to all(be_a Float)
+          expect(duration.values).to all(be_an Integer)
         end
       end
 
@@ -755,7 +773,7 @@ describe Yt::Video, :partner do
           duration = video.average_view_duration range.merge by: :state
           expect(duration.keys).to all(be_a String)
           expect(duration.keys.map(&:length).uniq).to eq [2]
-          expect(duration.values).to all(be_a Float)
+          expect(duration.values).to all(be_an Integer)
         end
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yt
 version: !ruby/object:Gem::Version
-  version: 0.23.2
+  version: 0.24.0
 platform: ruby
 authors:
 - Claudio Baccigalupo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-20 00:00:00.000000000 Z
+date: 2015-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport