yt 0.14.1 → 0.14.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db4db84624546717fdc851f9686077c0926798ac
-  data.tar.gz: 69322165d6a6a13484613c7d1f3e3fda0c3c79d4
+  metadata.gz: 3ab7c0d75dc3c575f9c55dd9e222505f70db290f
+  data.tar.gz: 1594d3e696c068d0a439396591e6a41efb292dd0
 SHA512:
-  metadata.gz: fe0e64e30469c9539c4e5441e6d691bf91f6bf3f66e5d1cfbf6aa4a790a79e21aeeea6a4c2e02eb4d147817467e052409789054bd369268cba906759563fd655
-  data.tar.gz: c4e6b9bbab1327dcc20acbdd65260d83b6ec06723a21a098efcb0bbb6fc5ef9555a6897d1a86dd48b120e86ee58857b051c383089f1503a49c48bce8659098be
+  metadata.gz: 5205274ae1d25ce04a75f6d5cd92742e1cfa77930695795a13879f463dcbaf0c5d5d25e56ef799bf90506c0494a29e732133faab705da4c9c32d2cf54bbb7d38
+  data.tar.gz: 42810660757c546f295d1f8b038ce2b7cefb74b30c20327cc7d1548e19562c07c06cfc3e53b867d604ef0156edc4be96bfcdc656acaeda030c87d1ef89441f2a

data/CHANGELOG.md

@@ -6,6 +6,12 @@ For more information about changelogs, check
 [Keep a Changelog](http://keepachangelog.com) and
 [Vandamme](http://tech-angels.github.io/vandamme).
 
+## 0.14.2 - 2015-04-08
+
+* [FEATURE] Make `Annotation#text` a public method.
+* [FEATURE] Make `data` a public method for Snippet, Status, ContentDetail and StatisticsSet.
+* [FEATURE] Add .includes to .videos, so you can eager load snippet, status, statistics and content details for a collection of videos
+
 ## 0.14.1 - 2015-03-30
 
 * [FEATURE] New `monetized playbacks` report for channels.

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

data/bin/yt

@@ -7,100 +7,24 @@ rescue LoadError
   require 'yt'
 end
 
-############################
-
-# account = Yt::Account.new refresh_token: ENV['YT_TEST_DEVICE_REFRESH_TOKEN']
-
-# youtube.readonly and yt-analytics.readonly are not available with device :(
-account = Yt::Account.new scopes: %w(userinfo.email userinfo.profile youtube)
-0.upto(60) do |i|
-  begin
-    break if account.authentication
-  rescue Yt::Errors::MissingAuth => e
-    puts e.more_details if i.zero?
-    5.times {print '.'; sleep 1}
+Yt.configuration.log_level = :debug
+id = ARGV[1] || 'BPNYv0vd78A'
+
+case ARGV[0]
+when 'info'
+  puts "Yt version #{Yt::VERSION}"
+  video = Yt::Video.new id: id
+  puts video.annotations.first.text
+when 'annotations'
+  video = Yt::Video.new id: id
+  count = video.annotations.size
+  puts "Video #{id} has #{count} #{'annotation'.pluralize count}"
+  video.annotations.each.with_index do |annotation, i|
+    puts "#{i+1}) #{annotation.text}"
   end
+when 'video'
+  video = Yt::Video.new id: id
+  views = "#{video.view_count} #{'view'.pluralize video.view_count}"
+  likes = "#{video.like_count} #{'like'.pluralize video.like_count}"
+  puts "'#{video.title}' by #{video.channel_title} has #{views} and #{likes}"
 end
-
-puts "\nACCOUNT:\n"
-puts "  ID: #{account.id}"
-puts "  Email: #{account.email}"
-puts "  Email verified? #{account.has_verified_email?}"
-puts "  Gender: #{account.gender}"
-puts "  Name: #{account.name}"
-puts "  Given Name: #{account.given_name}"
-puts "  Family Name: #{account.family_name}"
-puts "  Profile URL: #{account.profile_url}"
-puts "  Avatar URL: #{account.avatar_url}"
-puts "  Locale: #{account.locale}"
-puts "  Hd? #{account.hd}"
-
-puts "\nCHANNEL:\n"
-channel = account.channel
-puts "  Title: #{channel.title}"
-puts "  Description: #{channel.description.truncate(30)}"
-puts "  Thumbnail URL: #{channel.thumbnail_url}"
-puts "  Published at: #{channel.published_at}"
-puts "  Public? #{channel.public?}"
-puts "  Views: #{channel.view_count}"
-puts "  Comments: #{channel.comment_count}"
-puts "  Videos: #{channel.video_count}"
-puts "  Subscribers: #{channel.subscriber_count}"
-puts "  Subscribers are visible? #{channel.subscriber_count_visible?}"
-# These are not available with a device auth :(
-# puts "  Views: #{channel.views}"
-# puts "  Comments: #{channel.comments}"
-# puts "  Likes: #{channel.likes}"
-# puts "  Dislikes: #{channel.dislikes}"
-# puts "  Shares: #{channel.shares}"
-# puts "  Viewers: #{channel.viewer_percentages}"
-
-account.videos.first(5).each.with_index do |video, i|
-  puts "\nVIDEO #{i+1}:\n"
-  puts "  Title: #{video.title}"
-  puts "  Description: #{video.description.truncate(30)}"
-  puts "  Thumbnail URL: #{video.thumbnail_url}"
-  puts "  Published at: #{video.published_at}"
-  puts "  Tags: #{video.tags}"
-  puts "  Channel ID: #{video.channel_id}"
-  puts "  Channel Title: #{video.channel_title}"
-  puts "  Category ID: #{video.category_id}"
-  puts "  Live content? #{video.live_broadcast_content}"
-  puts "  Public? #{video.public?}"
-  puts "  Views: #{video.view_count}"
-  puts "  Comments: #{video.comment_count}"
-  puts "  Likes: #{video.like_count}"
-  puts "  Dislikes: #{video.dislike_count}"
-  puts "  Favorites: #{video.favorite_count}"
-  puts "  Duration: #{video.duration}s"
-  puts "  HD: #{video.hd?}"
-  puts "  stereoscopic? #{video.stereoscopic?}"
-  puts "  captioned? #{video.captioned?}"
-  puts "  licensed? #{video.licensed?}"
-  # These are not available with a device auth :(
-  # puts "  Views: #{video.views}"
-  # puts "  Comments: #{video.comments}"
-  # puts "  Likes: #{video.likes}"
-  # puts "  Dislikes: #{video.dislikes}"
-  # puts "  Shares: #{video.shares}"
-  # puts "  Viewers: #{video.viewer_percentages}"
-  puts "  Annotations: #{video.annotations.count}"
-end
-
-account.playlists.first(5).each.with_index do |playlist, i|
-  puts "\nPLAYLIST #{i+1}:\n"
-  puts "  Title: #{playlist.title}"
-  puts "  Description: #{playlist.description.truncate(30)}"
-  puts "  Thumbnail URL: #{playlist.thumbnail_url}"
-  puts "  Published at: #{playlist.published_at}"
-  puts "  Tags: #{playlist.tags}"
-  puts "  Channel ID: #{playlist.channel_id}"
-  puts "  Channel Title: #{playlist.channel_title}"
-  puts "  Public? #{playlist.public?}"
-  puts "  Playlist items: #{playlist.playlist_items.count}"
-  playlist.playlist_items.first(5).each.with_index do |playlist_item, j|
-    puts "    \nPLAYLIST ITEM #{j+1}:\n"
-    puts "    Position: #{playlist_item.position + 1}"
-    puts "    Video ID: #{playlist_item.video_id}"
-  end
-end

data/lib/yt/collections/base.rb

@@ -41,11 +41,22 @@ module Yt
         end
       end
 
+      def includes(*relationships)
+        self.tap do
+          @items = []
+          @included_relationships = relationships
+        end
+      end
+
     private
 
       def apply_where_params!(params = {})
         params.merge!(@where_params ||= {})
       end
+
+      def included_relationships
+        @included_relationships || []
+      end
     end
   end
 end

data/lib/yt/collections/partnered_channels.rb

@@ -4,13 +4,6 @@ module Yt
   module Collections
     class PartneredChannels < Channels
 
-      def includes(relationship)
-        self.tap do
-          @items = []
-          @includes_relationship = relationship
-        end
-      end
-
     private
 
       def attributes_for_new_item(data)
@@ -20,7 +13,7 @@ module Yt
       end
 
       def eager_load_items_from(items)
-        if @includes_relationship == :viewer_percentages
+        if included_relationships.include? :viewer_percentages
           filters = "channel==#{items.map{|item| item['id']}.join(',')}"
           ids = "contentOwner==#{@auth.owner_name}"
           conditions = {ids: ids, filters: filters}
@@ -30,7 +23,7 @@ module Yt
             item['viewerPercentages'] = viewer_percentages[item['id']]
           end
         end
-        items
+        super
       end
 
       # @private

data/lib/yt/collections/reports.rb

@@ -3,10 +3,10 @@ require 'yt/collections/base'
 module Yt
   module Collections
     class Reports < Base
-      DIMENSIONS = Hash.new({name: 'day', parse: -> (day) {Date.iso8601 day} }).tap do |hash|
-        hash[:traffic_source] = {name: 'insightTrafficSourceType', parse: -> (type) {TRAFFIC_SOURCES.key type} }
-        hash[:video] = {name: 'video', parse: -> (video_id) { Yt::Video.new id: video_id, auth: @auth } }
-        hash[:playlist] = {name: 'playlist', parse: -> (playlist_id) { Yt::Playlist.new id: playlist_id, auth: @auth } }
+      DIMENSIONS = Hash.new({name: 'day', parse: ->(day) {Date.iso8601 day} }).tap do |hash|
+        hash[:traffic_source] = {name: 'insightTrafficSourceType', parse: ->(type) {TRAFFIC_SOURCES.key type} }
+        hash[:video] = {name: 'video', parse: ->(video_id) { Yt::Video.new id: video_id, auth: @auth } }
+        hash[:playlist] = {name: 'playlist', parse: ->(playlist_id) { Yt::Playlist.new id: playlist_id, auth: @auth } }
       end
 
       # @see https://developers.google.com/youtube/analytics/v1/dimsmets/dims#Traffic_Source_Dimensions
@@ -80,4 +80,4 @@ module Yt
       end
     end
   end
-end
+end

data/lib/yt/collections/videos.rb

@@ -8,12 +8,16 @@ module Yt
     # Resources with videos are: {Yt::Models::Channel channels} and
     # {Yt::Models::Account accounts}.
     class Videos < Base
+      def where(requirements = {})
+        @published_before = nil
+        super
+      end
 
     private
 
       def attributes_for_new_item(data)
         id = use_list_endpoint? ? data['id'] : data['id']['videoId']
-        snippet = data['snippet'].merge includes_tags: false if data['snippet']
+        snippet = data['snippet'].reverse_merge includes_tags: false if data['snippet']
         {}.tap do |attributes|
           attributes[:id] = id
           attributes[:snippet] = snippet
@@ -24,6 +28,28 @@ module Yt
         end
       end
 
+      def eager_load_items_from(items)
+        if included_relationships.any?
+          ids = items.map{|item| item['id']['videoId']}
+          parts = included_relationships.map{|r| r.to_s.camelize(:lower)}
+          conditions = {id: ids.join(','), part: parts.join(',')}
+          videos = Collections::Videos.new(auth: @auth).where conditions
+
+          items.each do |item|
+            video = videos.find{|v| v.id == item['id']['videoId']}
+            parts.each do |part|
+              item[part] = case part
+                when 'snippet' then video.snippet.data.merge includes_tags: true
+                when 'status' then video.status.data
+                when 'statistics' then video.statistics_set.data
+                when 'contentDetails' then video.content_detail.data
+              end
+            end
+          end
+        end
+        super
+      end
+
       # @return [Hash] the parameters to submit to YouTube to list videos.
       # @see https://developers.google.com/youtube/v3/docs/search/list
       def list_params

data/lib/yt/models/annotation.rb

@@ -71,12 +71,12 @@ module Yt
         timestamps.first < seconds if timestamps.any?
       end
 
-    private
-
       def text
         @text ||= @data['TEXT'] || ''
       end
 
+    private
+
       has_attribute :type, default: ''
 
       def link_class

data/lib/yt/models/content_detail.rb

@@ -6,6 +6,7 @@ module Yt
     # of the video and an indication of whether captions are available.
     # @see https://developers.google.com/youtube/v3/docs/videos#resource
     class ContentDetail < Base
+      attr_reader :data
 
       def initialize(options = {})
         @data = options[:data]

data/lib/yt/models/snippet.rb

@@ -12,6 +12,8 @@ module Yt
     # @see https://developers.google.com/youtube/v3/docs/playlists#resource
     # @see https://developers.google.com/youtube/v3/docs/playlistItems#resource
     class Snippet < Base
+      attr_reader :data
+
       def initialize(options = {})
         @data = options[:data]
         @auth = options[:auth]
@@ -153,7 +155,7 @@ module Yt
       # @see https://developers.google.com/youtube/v3/docs/videos
       # @return [Boolean] whether YouTube API includes tags in this snippet.
       def includes_tags
-        @includes_tags ||= @data.fetch :includes_tags, true
+        @includes_tags ||= data.fetch :includes_tags, true
       end
 
     private

data/lib/yt/models/statistics_set.rb

@@ -6,6 +6,8 @@ module Yt
     # the resource has been viewed or liked.
     # @see https://developers.google.com/youtube/v3/docs/videos#resource
     class StatisticsSet < Base
+      attr_reader :data
+
       def initialize(options = {})
         @data = options[:data]
       end

data/lib/yt/models/status.rb

@@ -12,6 +12,8 @@ module Yt
     # @see https://developers.google.com/youtube/v3/docs/playlists#resource
     # @see https://developers.google.com/youtube/v3/docs/playlistItems#resource
     class Status < Base
+      attr_reader :data
+
       def initialize(options = {})
         @data = options[:data]
       end

data/lib/yt/version.rb

@@ -1,3 +1,3 @@
 module Yt
-  VERSION = '0.14.1'
+  VERSION = '0.14.2'
 end

data/spec/models/annotation_spec.rb

@@ -43,6 +43,13 @@ describe Yt::Annotation do
     end
   end
 
+  describe '#text' do
+    context 'given an annotation with text' do
+      let(:xml) { '<TEXT>Hello, world!</TEXT>' }
+      it { expect(annotation.text).to eq 'Hello, world!' }
+    end
+  end
+
   describe '#has_link_to_subscribe?' do
     context 'given an annotation with a link of class 5' do
       let(:xml) { '<action type="openUrl"><url link_class="5"/></action>' }

data/spec/models/content_detail_spec.rb

@@ -4,6 +4,13 @@ require 'yt/models/content_detail'
 describe Yt::ContentDetail do
   subject(:content_detail) { Yt::ContentDetail.new data: data }
 
+  describe '#data' do
+    let(:data) { {"key"=>"value"} }
+    specify 'returns the data the content detail was initialized with' do
+      expect(content_detail.data).to eq data
+    end
+  end
+
   describe '#duration' do
     context 'given a content_detail with duration in weeks, days, hours, minutes' do
       let(:data) { {"duration"=>"P1W2DT6H21M32S"}}

data/spec/models/snippet_spec.rb

@@ -5,6 +5,13 @@ describe Yt::Snippet do
   subject(:snippet) { Yt::Snippet.new data: data }
   let(:data) { {} }
 
+  describe '#data' do
+    let(:data) { {"key"=>"value"} }
+    specify 'returns the data the snippet was initialized with' do
+      expect(snippet.data).to eq data
+    end
+  end
+
   describe '#title' do
     context 'given a snippet with a title' do
       let(:data) { {"title"=>"Fullscreen"} }

data/spec/models/statistics_set_spec.rb

@@ -5,6 +5,13 @@ describe Yt::StatisticsSet do
   subject(:statistics_set) { Yt::StatisticsSet.new data: data }
   let(:value) { 42 }
 
+  describe '#data' do
+    let(:data) { {"key"=>"value"} }
+    specify 'returns the data the statistics set was initialized with' do
+      expect(statistics_set.data).to eq data
+    end
+  end
+
   describe '#view_count' do
     context 'given a video with views' do
       let(:data) { {"viewCount"=>value} }

data/spec/models/status_spec.rb

@@ -4,6 +4,13 @@ require 'yt/models/status'
 describe Yt::Status do
   subject(:status) { Yt::Status.new data: data }
 
+  describe '#data' do
+    let(:data) { {"key"=>"value"} }
+    specify 'returns the data the status was initialized with' do
+      expect(status.data).to eq data
+    end
+  end
+
   describe '#public?' do
     context 'given fetching a status returns privacyStatus "public"' do
       let(:data) { {"privacyStatus"=>"public"} }

data/spec/requests/as_account/account_spec.rb

@@ -49,6 +49,33 @@ describe Yt::Account, :device_app do
       let(:other_video) { $account.videos.where(order: 'viewCount', chart: 'invalid').first }
       it { expect(other_video.id).to eq video.id }
     end
+
+    describe '.includes(:snippet)' do
+      let(:video) { $account.videos.includes(:snippet).first }
+
+      specify 'eager-loads the *full* snippet of each video' do
+        expect(video.instance_variable_defined? :@snippet).to be true
+        expect(video.channel_title).to be
+        expect(video.snippet.includes_tags).to be true
+      end
+    end
+
+    describe '.includes(:statistics, :status)' do
+      let(:video) { $account.videos.includes(:statistics, :status).first }
+
+      specify 'eager-loads the statistics and status of each video' do
+        expect(video.instance_variable_defined? :@statistics_set).to be true
+        expect(video.instance_variable_defined? :@status).to be true
+      end
+    end
+
+    describe '.includes(:content_details)' do
+      let(:video) { $account.videos.includes(:content_details).first }
+
+      specify 'eager-loads the statistics of each video' do
+        expect(video.instance_variable_defined? :@content_detail).to be true
+      end
+    end
   end
 
   describe '.upload_video' do

data/spec/requests/as_account/channel_spec.rb

@@ -21,7 +21,68 @@ describe Yt::Channel, :device_app do
       expect(channel.subscriber_count_visible?).to be_in [true, false]
     end
 
-    it { expect(channel.videos.first).to be_a Yt::Video }
+    describe '.videos' do
+      let(:video) { channel.videos.first }
+
+      specify 'returns the videos in the channel without their tags' do
+        expect(video).to be_a Yt::Video
+        expect(video.snippet.includes_tags).to be false
+      end
+
+      describe '.where(id: *anything*)' do
+        let(:video) { channel.videos.where(id: 'invalid').first }
+
+        specify 'is ignored (all the channel’s videos are returned)' do
+          expect(video).to be_a Yt::Video
+        end
+      end
+
+      describe '.where(chart: *anything*)' do
+        let(:video) { channel.videos.where(chart: 'invalid').first }
+
+        specify 'is ignored (all the channel’s videos are returned)' do
+          expect(video).to be_a Yt::Video
+        end
+      end
+
+      describe '.includes(:statistics, :status)' do
+        let(:video) { channel.videos.includes(:statistics, :status).first }
+
+        specify 'eager-loads the statistics and status of each video' do
+          expect(video.instance_variable_defined? :@statistics_set).to be true
+          expect(video.instance_variable_defined? :@status).to be true
+        end
+      end
+
+      describe '.includes(:content_details)' do
+        let(:video) { channel.videos.includes(:content_details).first }
+
+        specify 'eager-loads the statistics of each video' do
+          expect(video.instance_variable_defined? :@content_detail).to be true
+        end
+      end
+
+
+      describe 'when the channel has more than 500 videos' do
+        let(:id) { 'UCsmvakQZlvGsyjyOhmhvOsw' }
+
+        specify 'the estimated and actual number of videos can be retrieved' do
+          # @note: in principle, the following three counters should match, but
+          #   in reality +video_count+ and +size+ are only approximations.
+          expect(channel.video_count).to be > 500
+          expect(channel.videos.size).to be > 500
+        end
+
+        specify 'over 500 videos can only be retrieved when sorting by date' do
+          # @note: these tests are slow because they go through multiple pages
+          # of results to test that we can overcome YouTube’s limitation of only
+          # returning the first 500 results when ordered by date.
+          expect(channel.videos.count).to be > 500
+          expect(channel.videos.where(order: 'viewCount').count).to be 500
+        end
+      end
+    end
+
     it { expect(channel.playlists.first).to be_a Yt::Playlist }
     it { expect{channel.delete_playlists}.to raise_error Yt::Errors::RequestError }
 
@@ -70,29 +131,6 @@ describe Yt::Channel, :device_app do
         it { expect(channel.subscribe!).to be_truthy }
       end
     end
-
-    describe 'filtering by ID is ignored when listing videos' do
-      it { expect(channel.videos.where(id: 'invalid').first).to be_a Yt::Video }
-    end
-
-    describe 'filtering by chart is ignored when listing videos' do
-      it { expect(channel.videos.where(chart: 'invalid').first).to be_a Yt::Video }
-    end
-
-    context 'with more than 500 videos' do
-      let(:id) { 'UCsmvakQZlvGsyjyOhmhvOsw' }
-      # @note: in principle, the following three counters should match, but in
-      #   reality +video_count+ and +size+ are only approximations.
-      it { expect(channel.video_count).to be > 500 }
-      it { expect(channel.videos.size).to be > 500 }
-      context 'with default order (by date)' do
-        # @note: these tests are slow because they go through multiple pages of
-        # results and do so to test that we can overcome YouTube’s limitation of
-        # only returning the first 500 results when ordered by date.
-        it { expect(channel.videos.count).to be > 500 }
-        it { expect(channel.videos.where(order: 'viewCount').count).to be 500 }
-      end
-    end
   end
 
   context 'given my own channel' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yt
 version: !ruby/object:Gem::Version
-  version: 0.14.1
+  version: 0.14.2
 platform: ruby
 authors:
 - Claudio Baccigalupo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-31 00:00:00.000000000 Z
+date: 2015-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport