yt 0.24.7 → 0.24.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8fdec6049878d1f96dfb941ab2716fc3146e61c7
-  data.tar.gz: e7d54a900325067ba66fd17e42138dbb197ffec2
+  metadata.gz: 393804430300ba24dfed2e8d04a72005eec8bd74
+  data.tar.gz: 36a59293e808300580f0f0500e7aac5891204572
 SHA512:
-  metadata.gz: 80cd1f43b207221e568aad90ab1fba921b44a3d33a7265a7d58303b76e5a322e2734872d4a6d825f41fdf8ee01b1e224ad6426dd4cc08199e2e57b1bf849b344
-  data.tar.gz: e2cc67add9e2b91a4f0770c31df76d54579d3f0034a4b8aef74783a3f76f0f1afd638d39275396954d0a07886aba39701c46294764eb7f1ee42763b5560ed2a4
+  metadata.gz: ab215a61d381055c52fafbe91b0a38acb05b8f262164375713724557d7148774d281539e74b3eca471f3ac5bd17491bc4ecbb90b25f071ba56bdf0dd1fc7879a
+  data.tar.gz: 5af865f608ffae8c1526ed46283932e13f2be206f759382b1f877bdd001693fdcbc1f820f7924667f3c538666a6673af05270fa68b757f93ec2a6aefb704e127

data/CHANGELOG.md

@@ -6,6 +6,11 @@ For more information about changelogs, check
 [Keep a Changelog](http://keepachangelog.com) and
 [Vandamme](http://tech-angels.github.io/vandamme).
 
+## 0.24.8 - 2015-06-18
+
+* [FEATURE] New `by: :week` option for reports.
+* [FEATURE] New Video#age_restricted? method
+
 ## 0.24.7 - 2015-06-08
 
 * [ENHANCEMENT] Add `:videos` option to limit channel reports to subset of videos

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.7'
+    gem 'yt', '~> 0.24.8'
 
 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

@@ -10,7 +10,7 @@ module Yt
       #   @option options [Array<Symbol>] :only The metrics to generate reports
       #     for.
       #   @option options [Symbol] :by (:day) The dimension to collect metrics
-      #     by. Accepted values are: +:day+, +:month+.
+      #     by. Accepted values are: +:day+, +:week+, +:month+.
       #   @option options [#to_date] :since The first day of the time-range.
       #     Also aliased as +:from+.
       #   @option options [#to_date] :until The last day of the time-range.
@@ -40,6 +40,11 @@ module Yt
       #   @example Get the $1 for this and last month:
       #     resource.$1 since: 1.month.ago, by: :month
       #     # => {Wed, 01 Apr 2014..Thu, 30 Apr 2014 => 12.0, Fri, 01 May 2014..Sun, 31 May 2014 => 34.0, …}
+      #   @return [Hash<Range<Date, Date>, $2>] if grouped by week, the $1
+      #     for each week in the time-range.
+      #   @example Get the $1 for this and last week:
+      #     resource.$1 since: 1.week.ago, by: :week
+      #     # => {Wed, 01 Apr 2014..Tue, 07 Apr 2014 => 20.0, Wed, 08 Apr 2014..Tue, 14 Apr 2014 => 13.0, …}
       #   @macro report
 
       # @!macro [new] report_with_range
@@ -70,19 +75,19 @@ module Yt
 
       # @!macro [new] report_by_day
       #   @option options [Symbol] :by (:day) The dimension to collect $1 by.
-      #     Accepted values are: +:day+, +:month+.
+      #     Accepted values are: +:day+, +:week+, +:month+.
       #   @macro report_with_day
 
       # @!macro [new] report_by_day_and_country
       #   @option options [Symbol] :by (:day) The dimension to collect $1 by.
-      #     Accepted values are: +:day+, +:month+, :+range+.
+      #     Accepted values are: +:day+, +:week+, +:month+, :+range+.
       #   @macro report_with_day
       #   @macro report_with_range
       #   @macro report_with_country
 
       # @!macro [new] report_by_day_and_state
       #   @option options [Symbol] :by (:day) The dimension to collect $1 by.
-      #     Accepted values are: +:day+, +:month+, :+range+.
+      #     Accepted values are: +:day+, +:week+, +:month+, :+range+.
       #   @macro report_with_day
       #   @macro report_with_range
       #   @macro report_with_country_and_state
@@ -123,9 +128,9 @@ module Yt
 
       # @!macro [new] report_by_video_dimensions
       #   @option options [Symbol] :by (:day) The dimension to collect $1 by.
-      #     Accepted values are: +:day+, +:month+, +:range+, +:traffic_source+,
-      #     +:search_term+, +:playback_location+, +:related_video+,
-      #     +:embedded_player_location+.
+      #     Accepted values are: +:day+, +:week+, +:month+, +:range+,
+      #     +:traffic_source+,+:search_term+, +:playback_location+,
+      #     +:related_video+, +:embedded_player_location+.
       #   @option options [Array<Symbol>] :includes ([:id]) if grouped by
       #     related video, the parts of each video to eager-load. Accepted
       #     values are: +:id+, +:snippet+, +:status+, +:statistics+,
@@ -157,9 +162,9 @@ module Yt
 
       # @!macro [new] report_by_channel_dimensions
       #   @option options [Symbol] :by (:day) The dimension to collect $1 by.
-      #     Accepted values are: +:day+, +:month+, +:range+, +:traffic_source+,
-      #     +:search_term+, +:playback_location+, +:related_video+, +:video+,
-      #     +:playlist+, +:embedded_player_location+.
+      #     Accepted values are: +:day+, +:week+, +:month+, +:range+,
+      #     +:traffic_source+, +:search_term+, +:playback_location+, +:video+,
+      #     +:related_video+, +:playlist+, +:embedded_player_location+.
       #   @return [Hash<Symbol, $2>] if grouped by embedded player location,
       #     the $1 for each embedded player location.
       #   @example Get yesterday’s $1 by embedded player location:
@@ -170,8 +175,8 @@ module Yt
 
       # @!macro [new] report_by_playlist_dimensions
       #   @option options [Symbol] :by (:day) The dimension to collect $1 by.
-      #     Accepted values are: +:day+, +:month+, +:range+, +:traffic_source+,
-      #     +:playback_location+, +:related_video+, +:video+,
+      #     Accepted values are: +:day+, +:week+, +:month+, +:range+,
+      #     +:traffic_source+, +:playback_location+, +:related_video+, +:video+,
       #     +:playlist+.
       #   @macro report_with_channel_dimensions
       #   @macro report_with_country_and_state
@@ -230,7 +235,7 @@ module Yt
       def define_reports_method(metric, type)
         (@metrics ||= {})[metric] = type
         define_method :reports do |options = {}|
-          from = options[:since] || options[:from] || (options[:by].in?([:day, :month]) ? 5.days.ago : '2005-02-01')
+          from = options[:since] || options[:from] || (options[:by].in?([:day, :week, :month]) ? 5.days.ago : '2005-02-01')
           to = options[:until] || options[:to] || Date.today
           location = options[:in]
           country = location.is_a?(Hash) ? location[:country] : location
@@ -253,7 +258,7 @@ module Yt
 
       def define_metric_method(metric)
         define_method metric do |options = {}|
-          from = options[:since] || options[:from] || (options[:by].in?([:day, :month]) ? 5.days.ago : '2005-02-01')
+          from = options[:since] || options[:from] || (options[:by].in?([:day, :week, :month]) ? 5.days.ago : '2005-02-01')
           to = options[:until] || options[:to] || Date.today
           location = options[:in]
           country = location.is_a?(Hash) ? location[:country] : location

data/lib/yt/collections/reports.rb

@@ -6,6 +6,7 @@ module Yt
     class Reports < Base
       DIMENSIONS = Hash.new({name: 'day', parse: ->(day, *values) { @metrics.keys.zip(values.map{|v| {Date.iso8601(day) => v}}).to_h} }).tap do |hash|
         hash[:month] = {name: 'month', parse: ->(month, *values) { @metrics.keys.zip(values.map{|v| {Range.new(Date.strptime(month, '%Y-%m').beginning_of_month, Date.strptime(month, '%Y-%m').end_of_month) => v} }).to_h} }
+        hash[:week] = {name: '7DayTotals', parse: ->(last_day_of_week, *values) { @metrics.keys.zip(values.map{|v| {Range.new(Date.strptime(last_day_of_week) - 6, Date.strptime(last_day_of_week)) => v} }).to_h} }
         hash[:range] = {parse: ->(*values) { @metrics.keys.zip(values.map{|v| {total: v}}).to_h } }
         hash[:traffic_source] = {name: 'insightTrafficSourceType', parse: ->(source, *values) { @metrics.keys.zip(values.map{|v| {TRAFFIC_SOURCES.key(source) => v}}).to_h} }
         hash[:playback_location] = {name: 'insightPlaybackLocationType', parse: ->(location, *values) { @metrics.keys.zip(values.map{|v| {PLAYBACK_LOCATIONS.key(location) => v}}).to_h} }
@@ -77,6 +78,11 @@ module Yt
           end
           if dimension == :month
             hash = hash.transform_values{|h| h.sort_by{|range, v| range.first}.to_h}
+          elsif dimension == :week
+            hash = hash.transform_values do |h|
+              h.select{|range, v| range.last.wday == days_range.last.wday}.
+              sort_by{|range, v| range.first}.to_h
+            end
           elsif dimension == :day
             hash = hash.transform_values{|h| h.sort_by{|day, v| day}.to_h}
           elsif dimension.in? [:traffic_source, :country, :state, :playback_location, :device_type]

data/lib/yt/models/content_detail.rb

@@ -22,6 +22,11 @@ module Yt
       has_attribute :definition
       has_attribute :caption
       has_attribute :licensed_content
+      has_attribute :content_rating, default: {}
+
+      def youtube_rating
+        content_rating['ytRating']
+      end
 
     private
 
@@ -57,4 +62,4 @@ module Yt
       end
     end
   end
-end
+end

data/lib/yt/models/video.rb

@@ -247,6 +247,12 @@ module Yt
         content_detail.licensed_content || false
       end
 
+      # @return [Boolean] whether the video is identified by YouTube as
+      #   age-restricted content.
+      def age_restricted?
+        content_detail.youtube_rating == 'ytAgeRestricted'
+      end
+
     ### FILE DETAILS ###
 
       has_one :file_detail

data/lib/yt/version.rb

@@ -1,3 +1,3 @@
 module Yt
-  VERSION = '0.24.7'
+  VERSION = '0.24.8'
 end

data/spec/models/video_spec.rb

@@ -473,6 +473,23 @@ describe Yt::Video do
     end
   end
 
+  describe '#age_restricted?' do
+    context 'given a video with age restricted content' do
+      let(:attrs) { {content_details: {"contentRating"=>{"ytRating"=>"ytAgeRestricted"}}} }
+      it { expect(video).to be_age_restricted }
+    end
+
+    context 'given a video without age restricted content' do
+      let(:attrs) { {content_details: {}} }
+      it { expect(video).not_to be_age_restricted }
+    end
+
+    context 'given a video with a content rating but not ytRating' do
+      let(:attrs) { {content_details: {"contentRating"=>{"acbRating": "PG"}}} }
+      it { expect(video).not_to be_age_restricted }
+    end
+  end
+
   describe '#file_size' do
     context 'given a video with fileSize' do
       let(:attrs) { {file_details: {"fileSize"=>"8000000"}} }
@@ -649,4 +666,4 @@ describe Yt::Video do
       it { expect{video.delete}.to change{video.exists?} }
     end
   end
-end
+end

data/spec/requests/as_content_owner/channel_spec.rb

@@ -42,6 +42,18 @@ describe Yt::Channel, :partner do
             expect(result[metric].values).to all(be_a type)
           end
         end
+
+        specify 'by week' do
+          range = {since: ENV['YT_TEST_PARTNER_VIDEO_DATE'], until: Date.parse(ENV['YT_TEST_PARTNER_VIDEO_DATE']) + 9}
+          result = channel.reports range.merge(only: metrics, by: :week)
+          metrics.each do |metric, type|
+            expect(result[metric].size).to be <= 2
+            expect(result[metric].keys).to all(be_a Range)
+            expect(result[metric].keys.map{|range| range.first.wday}.uniq).to be_one
+            expect(result[metric].keys.map{|range| range.last.wday}.uniq).to be_one
+            expect(result[metric].values).to all(be_a type)
+          end
+        end
       end
 
       [:views, :uniques, :comments, :likes, :dislikes, :shares,
@@ -86,6 +98,18 @@ describe Yt::Channel, :partner do
             expect(result.keys.map &:last).to eq result.keys.map(&:last).map(&:end_of_month)
           end
         end
+
+        describe "#{metric} can be grouped by week and returns non-overlapping periods" do
+          let(:metric) { metric }
+          let(:range) { {since: ENV['YT_TEST_PARTNER_VIDEO_DATE'], until: Date.parse(ENV['YT_TEST_PARTNER_VIDEO_DATE']) + 9} }
+          let(:result) { channel.public_send metric, range.merge(by: :week)}
+          specify do
+            expect(result.size).to be <= 2
+            expect(result.keys).to all(be_a Range)
+            expect(result.keys.map{|range| range.first.wday}.uniq).to be_one
+            expect(result.keys.map{|range| range.last.wday}.uniq).to be_one
+          end
+        end
       end
 
       {views: Integer, comments: Integer, likes: Integer, dislikes: Integer,
@@ -452,12 +476,21 @@ describe Yt::Channel, :partner do
       describe 'views can be limited to a subset of videos' do
         let(:range) { {since: ENV['YT_TEST_PARTNER_VIDEO_DATE']} }
         let(:videos) { channel.videos.first(2) }
+        let(:video_views) { videos.inject(0){|total, video| total + video.views(range)[:total]} }
 
         specify 'with the :videos option listing the video IDs' do
-          video_views = videos.inject(0){|total, video| total + video.views(range)[:total]}
           views = channel.views range.merge videos: videos.map(&:id)
           expect(views[:total]).to eq video_views
         end
+
+        specify 'with a maximum of 200 video IDs' do
+          views = channel.views range.merge videos: (videos*100).map(&:id)
+          expect(views[:total]).to eq video_views
+        end
+
+        specify 'but fails with more than 200 video IDs' do
+          expect{channel.views range.merge videos: (videos*101).map(&:id)}.to raise_error Yt::Errors::RequestError
+        end
       end
 
       describe 'uniques can be retrieved for a single country' do

data/spec/requests/as_content_owner/playlist_spec.rb

@@ -35,6 +35,18 @@ describe Yt::Playlist, :partner do
             expect(result[metric].values).to all(be_a type)
           end
         end
+
+        specify 'by week' do
+          range = {since: ENV['YT_TEST_PARTNER_VIDEO_DATE'], until: Date.parse(ENV['YT_TEST_PARTNER_VIDEO_DATE']) + 9}
+          result = playlist.reports range.merge(only: metrics, by: :week)
+          metrics.each do |metric, type|
+            expect(result[metric].size).to be <= 2
+            expect(result[metric].keys).to all(be_a Range)
+            expect(result[metric].keys.map{|range| range.first.wday}.uniq).to be_one
+            expect(result[metric].keys.map{|range| range.last.wday}.uniq).to be_one
+            expect(result[metric].values).to all(be_a type)
+          end
+        end
       end
 
       {views: Integer, estimated_minutes_watched: Integer,
@@ -76,6 +88,18 @@ describe Yt::Playlist, :partner do
           end
         end
 
+        describe "#{metric} can be grouped by week and returns non-overlapping periods" do
+          let(:metric) { metric }
+          let(:range) { {since: ENV['YT_TEST_PARTNER_VIDEO_DATE'], until: Date.parse(ENV['YT_TEST_PARTNER_VIDEO_DATE']) + 9} }
+          let(:result) { playlist.public_send metric, range.merge(by: :week)}
+          specify do
+            expect(result.size).to be <= 2
+            expect(result.keys).to all(be_a Range)
+            expect(result.keys.map{|range| range.first.wday}.uniq).to be_one
+            expect(result.keys.map{|range| range.last.wday}.uniq).to be_one
+          end
+        end
+
         describe "#{metric} can be retrieved for a specific day" do
           let(:metric) { metric }
           let(:result) { playlist.public_send "#{metric}_on", date }

data/spec/requests/as_content_owner/video_spec.rb

@@ -55,6 +55,18 @@ describe Yt::Video, :partner do
           end
         end
 
+        describe "#{metric} can be grouped by week and returns non-overlapping periods" do
+          let(:metric) { metric }
+          let(:range) { {since: ENV['YT_TEST_PARTNER_VIDEO_DATE'], until: Date.parse(ENV['YT_TEST_PARTNER_VIDEO_DATE']) + 9} }
+          let(:result) { video.public_send metric, range.merge(by: :week)}
+          specify do
+            expect(result.size).to be <= 2
+            expect(result.keys).to all(be_a Range)
+            expect(result.keys.map{|range| range.first.wday}.uniq).to be_one
+            expect(result.keys.map{|range| range.last.wday}.uniq).to be_one
+          end
+        end
+
         describe "#{metric} can be retrieved for a single country" do
           let(:result) { video.public_send metric, options }
 
@@ -225,6 +237,18 @@ describe Yt::Video, :partner do
             expect(result[metric].values).to all(be_a type)
           end
         end
+
+        specify 'by week' do
+          range = {since: ENV['YT_TEST_PARTNER_VIDEO_DATE'], until: Date.parse(ENV['YT_TEST_PARTNER_VIDEO_DATE']) + 9}
+          result = video.reports range.merge(only: metrics, by: :week)
+          metrics.each do |metric, type|
+            expect(result[metric].size).to be <= 2
+            expect(result[metric].keys).to all(be_a Range)
+            expect(result[metric].keys.map{|range| range.first.wday}.uniq).to be_one
+            expect(result[metric].keys.map{|range| range.last.wday}.uniq).to be_one
+            expect(result[metric].values).to all(be_a type)
+          end
+        end
       end
 
       describe 'earnings can be grouped by day' do

metadata

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