yt 0.24.10 → 0.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c98cdb00d48f25f00cd745199f5eff7615175a71
-  data.tar.gz: 0fca3d4e3194b62e72ecd9816e2e75f0cc1673ea
+  metadata.gz: c48d92d6630a165285e513cfac2088f1db048ecd
+  data.tar.gz: 06daf58ac858adcc4530aa48020d75f54fc2ece9
 SHA512:
-  metadata.gz: 1aa68d422315ff7e28ddaffce2ddd6a6d975df106fb4bc7b7373082633587e42539067f4e815c7fd9aa2f2b15798e89e960528778062bc0665f447c667213661
-  data.tar.gz: 736279c988e54f5f4231cbaafe47dbf678b2c3ce01a553d66f75f00399089e91e9810313ffb5dd2c0ea2ac110e7abbd46623e6460ebfb2fc761c4edd878b7744
+  metadata.gz: e884999cfe988df346878d3ddadd92192b13a05f83df035b452baf7ee7ee2f1bc3987ade999138a2a87af71a443beb9ea82ea038a948a95207054b2594d866ff
+  data.tar.gz: 80a2a1a53bd6faf28b3f629a4b7a051931e9be437428497237c2fdaa235c8bf3c1750094896aefd3c172277ab10e337b3317e19d243049608312eadf0a547ae8

data/CHANGELOG.md

@@ -6,6 +6,18 @@ For more information about changelogs, check
 [Keep a Changelog](http://keepachangelog.com) and
 [Vandamme](http://tech-angels.github.io/vandamme).
 
+## 0.25.0 - 2015-06-29
+
+**How to upgrade**
+
+If your code expects 10 videos when calling a report `by: :video` or
+`by: :related_video`, beware that those reports now return 25 videos.
+If you only need the first 10, just add `.first(10)` to your result.
+For instance: `channel.views(by: :video).first(10).to_h`.
+
+* [ENHANCEMENT] Return 25 results on reports by video / related video.
+* [FEATURE] New `playback_based_cpm` report for channels and videos.
+
 ## 0.24.10 - 2015-06-25
 
 * [BUGFIX] Don't break reports `by: :playlist` when trying to fetch their part by limiting to result to 50 playlists.
@@ -111,7 +123,7 @@ If your code expects any of the following method to return Float values, then
 be aware that they now return Integer. You can still call `to_f` if you do need
 a Float: views, `comments`, `likes`, `dislikes`, `shares`, `subscribers_gained`,
 `subscribers_lost`, `favorites_added`, `favorites_removed`, `annotations`,
-`impressions`, `monetized_plybacks`, `playlist_starts`.
+`impressions`, `monetized_playbacks`, `playlist_starts`.
 
 * [ENHANCEMENT] Return `Integer` values for reports that can never return decimal digits.
 * [FEATURE] New `by: :range` option for reports, to return a metric without dimensions (that is, for the whole range)

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

data/lib/yt/collections/reports.rb

@@ -128,10 +128,15 @@ module Yt
           params['end-date'] = @days_range.end
           params['metrics'] = @metrics.keys.join(',').to_s.camelize(:lower)
           params['dimensions'] = DIMENSIONS[@dimension][:name] unless @dimension == :range
-          params['max-results'] = 10 if @dimension == :video
-          params['max-results'] = 50 if @dimension == :playlist
+          params['max-results'] = 50 if @dimension.in? [:playlist, :video]
           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]
+          if @dimension.in? [:video, :playlist, :embedded_player_location, :related_video, :search_term, :referrer]
+            if @metrics.keys == [:earnings, :estimated_minutes_watched]
+              params['sort'] = '-earnings'
+            else
+              params['sort'] = "-#{@metrics.keys.join(',').to_s.camelize(:lower)}"
+            end
+          end
           params[:filters] = "video==#{@videos.join ','}" if @videos
           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

data/lib/yt/models/channel.rb

@@ -165,6 +165,9 @@ module Yt
       # @macro report_by_day_and_country
       has_report :monetized_playbacks, Integer
 
+      # @macro report_by_day_and_country
+      has_report :playback_based_cpm, Float
+
     ### STATISTICS ###
 
       has_one :statistics_set

data/lib/yt/models/video.rb

@@ -444,6 +444,9 @@ module Yt
       # @macro report_by_day_and_country
       has_report :monetized_playbacks, Integer
 
+      # @macro report_by_day_and_country
+      has_report :playback_based_cpm, Float
+
     ### STATISTICS ###
 
       has_one :statistics_set

data/lib/yt/version.rb

@@ -1,3 +1,3 @@
 module Yt
-  VERSION = '0.24.10'
+  VERSION = '0.25.0'
 end

data/spec/requests/as_account/channel_spec.rb

@@ -196,6 +196,7 @@ describe Yt::Channel, :device_app do
       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.playback_based_cpm}.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/video_spec.rb

@@ -302,6 +302,7 @@ describe Yt::Video, :device_app do
       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
+      expect{video.playback_based_cpm}.to raise_error Yt::Errors::Unauthorized
       expect{video.advertising_options_set}.to raise_error Yt::Errors::Forbidden
 
       expect{video.views_on 3.days.ago}.not_to raise_error

data/spec/requests/as_content_owner/channel_spec.rb

@@ -19,7 +19,7 @@ describe Yt::Channel, :partner do
           average_view_percentage: Float, annotation_clicks: Integer,
           annotation_click_through_rate: Float,
           annotation_close_rate: Float, earnings: Float, impressions: Integer,
-          monetized_playbacks: Integer}
+          monetized_playbacks: Integer, playback_based_cpm: Float}
 
         specify 'by day, and are chronologically sorted' do
           range = {since: 5.days.ago.to_date, until: 3.days.ago.to_date}
@@ -60,7 +60,7 @@ describe Yt::Channel, :partner do
        :subscribers_gained, :subscribers_lost, :favorites_added,
        :favorites_removed, :estimated_minutes_watched, :average_view_duration,
        :average_view_percentage, :impressions, :monetized_playbacks,
-       :annotation_clicks, :annotation_click_through_rate,
+       :annotation_clicks, :annotation_click_through_rate, :playback_based_cpm,
        :annotation_close_rate, :earnings].each do |metric|
         describe "#{metric} can be retrieved for a range of days" do
           let(:date_in) { ENV['YT_TEST_PARTNER_VIDEO_DATE'] }
@@ -118,7 +118,7 @@ describe Yt::Channel, :partner do
        annotation_clicks: Integer, annotation_click_through_rate: Float,
        favorites_added: Integer, favorites_removed: Integer,
        average_view_percentage: Float, impressions: Integer,
-       shares: Integer,
+       shares: Integer, playback_based_cpm: Float,
        monetized_playbacks: Integer, annotation_close_rate: Float,
        earnings: Float}.each do |metric, type|
         describe "#{metric} can be retrieved for a specific day" do
@@ -1477,6 +1477,61 @@ describe Yt::Channel, :partner do
         end
       end
 
+      describe 'playback-based CPM can be retrieved for a single country' do
+        let(:country_code) { 'US' }
+        let(:playback_based_cpm) { channel.playback_based_cpm since: date, by: by, in: location }
+        let(:date) { ENV['YT_TEST_PARTNER_VIDEO_DATE'] }
+
+        context 'and grouped by day' do
+          let(:by) { :day }
+
+          context 'with the :in option set to the country code' do
+            let(:location) { country_code }
+            it { expect(playback_based_cpm.keys.min).to eq date.to_date }
+          end
+
+          context 'with the :in option set to {country: country code}' do
+            let(:location) { {country: country_code} }
+            it { expect(playback_based_cpm.keys.min).to eq date.to_date }
+          end
+        end
+
+        context 'and grouped by country' do
+          let(:by) { :country }
+
+          context 'with the :in option set to the country code' do
+            let(:location) { country_code }
+            it { expect(playback_based_cpm.keys).to eq [country_code] }
+          end
+
+          context 'with the :in option set to {country: country code}' do
+            let(:location) { {country: country_code} }
+            it { expect(playback_based_cpm.keys).to eq [country_code] }
+          end
+        end
+      end
+
+      describe 'playback-based CPM 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 'with the :by option set to :day' do
+          playback_based_cpm = channel.playback_based_cpm range.merge by: :day
+          expect(playback_based_cpm.keys).to eq range.values
+        end
+      end
+
+      describe 'playback-based CPM can be grouped by country' do
+        let(:range) { {since: ENV['YT_TEST_PARTNER_PLAYLIST_DATE']} }
+
+        specify 'with the :by option set to :country' do
+          playbacks = channel.playback_based_cpm range.merge by: :country
+          expect(playbacks.keys).to all(be_a String)
+          expect(playbacks.keys.map(&:length).uniq).to eq [2]
+          expect(playbacks.values).to all(be_a Float)
+        end
+      end
+
       describe 'annotation clicks can be retrieved for a single country' do
         let(:country_code) { 'US' }
         let(:annotation_clicks) { channel.annotation_clicks since: date, by: by, in: location }

data/spec/requests/as_content_owner/video_spec.rb

@@ -17,7 +17,7 @@ describe Yt::Video, :partner do
        :subscribers_gained, :subscribers_lost, :favorites_added,
        :favorites_removed, :estimated_minutes_watched, :average_view_duration,
        :average_view_percentage, :impressions, :monetized_playbacks,
-       :annotation_clicks, :annotation_click_through_rate,
+       :annotation_clicks, :annotation_click_through_rate, :playback_based_cpm,
        :annotation_close_rate, :earnings].each do |metric|
         describe "#{metric} can be retrieved for a range of days" do
           let(:date_in) { ENV['YT_TEST_PARTNER_VIDEO_DATE'] }
@@ -924,6 +924,27 @@ describe Yt::Video, :partner do
         end
       end
 
+      describe 'playback-based CPM 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 'with the :by option set to :day' do
+          playback_based_cpm = video.playback_based_cpm range.merge by: :day
+          expect(playback_based_cpm.keys).to eq range.values
+        end
+      end
+
+      describe 'playback-based CPM can be grouped by country' do
+        let(:range) { {since: ENV['YT_TEST_PARTNER_VIDEO_DATE']} }
+
+        specify 'with the :by option set to :country' do
+          playbacks = video.playback_based_cpm range.merge by: :country
+          expect(playbacks.keys).to all(be_a String)
+          expect(playbacks.keys.map(&:length).uniq).to eq [2]
+          expect(playbacks.values).to all(be_a Float)
+        end
+      end
+
       describe 'annotation clicks can be retrieved for a single US state' do
         let(:state_code) { 'CA' }
         let(:clicks) { video.annotation_clicks since: date, by: by, in: location }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yt
 version: !ruby/object:Gem::Version
-  version: 0.24.10
+  version: 0.25.0
 platform: ruby
 authors:
 - Claudio Baccigalupo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-25 00:00:00.000000000 Z
+date: 2015-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport