yt 0.25.26 → 0.25.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 78dee68c38b98a14d9213c8f01b507425e25cca2
-  data.tar.gz: f859f557aef4fa1a76940ddaa5488af2515cb0df
+  metadata.gz: c5e0f3c2d22ca139c343e25b12d546f27fab7426
+  data.tar.gz: ab8d1de072cd33417b2276923dcef81f40fa5063
 SHA512:
-  metadata.gz: a98d8b324a2c866fb4ad872e22f7eda31c69dbfc4ce66e11abf5f63fa9a9e497b489a3554ba09baf1c4102b746829ca5fa29eecff3e93dea2887288e4a4ab88d
-  data.tar.gz: 8f0da58402c694c51f1b229bf4fd9afe0f2c638893d9086311bb82734639ae523c73b28d6ae441359dc309a2883d0ddfb549bfef56c95468b3648fc4a6cea3f1
+  metadata.gz: c9817c82f21347ab5b0b5f2d1b866ae5de343ece03e8abfd51902a141618eb766bfa4499c2248d124a38cbd7493eb47cd743698db9eca637fdfeefb6b552573a
+  data.tar.gz: 9687e59b2d140f368083380fe593c18818c60f5d03c1184c6b4d604c5f7f2420b57d64138ba6b8b2427cf097527b90e493598aa64cc3899799f4ec7cf97f2c69

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.25.27 - 2016-03-28
+
+* [FEATURE] Add `comment_threads` association to Yt::Video.
+* [FEATURE] Add `top_level_comment` and delegate its attributes (`text_display`, `author_display_name`, `like_count`, `updated_at`) to Yt::CommentThread.
+
 ## 0.25.26 - 2016-03-24
 
 * [FEATURE] Add Yt::Comment resource.

data/README.md

@@ -28,6 +28,9 @@ video.title #=> "Fullscreen Creator Platform"
 video.comment_count #=> 308
 video.hd? #=> true
 video.annotations.count #=> 1
+video.comment_threads #=> #<Yt::Collections::CommentThreads ...>
+# Use #take to limit the number of pages need to fetch from server
+video.comment_threads.take(99).map(&:author_display_name) #=> ["Paul", "Tommy", ...]
 ```
 
 The **full documentation** is available at [rubydoc.info](http://www.rubydoc.info/gems/yt/frames).
@@ -130,6 +133,12 @@ comment_thread.video_id #=> "1234"
 comment_thread.total_reply_count #=> 1
 comment_thread.can_reply? #=> true
 comment_thread.public? #=> true
+
+comment_thread.top_level_comment #=> #<Yt::Models::Comment ...>
+comment_thread.text_display #=> "funny video!"
+comment_thread.like_count #=> 9
+comment_thread.updated_at #=> 2016-03-22 12:56:56 UTC
+comment_thread.author_display_name #=> "Joe"
 ```
 
 Yt::Comment

data/lib/yt/actions/list.rb

@@ -6,7 +6,7 @@ require 'yt/config'
 module Yt
   module Actions
     module List
-      delegate :any?, :count, :each, :each_cons, :each_slice, :find, :first,
+      delegate :any?, :count, :each, :each_cons, :each_slice, :find, :first, :take,
         :flat_map, :map, :select, :size, to: :list
 
       def first!
@@ -136,4 +136,4 @@ module Yt
       end
     end
   end
-end
+end

data/lib/yt/collections/comment_threads.rb

@@ -0,0 +1,41 @@
+require 'yt/collections/base'
+require 'yt/models/video'
+require 'yt/models/channel'
+
+module Yt
+  module Collections
+    # @private
+    class CommentThreads < Base
+
+    private
+
+      def attributes_for_new_item(data)
+        {}.tap do |attributes|
+          attributes[:id] = data['id']
+          attributes[:snippet] = data['snippet']
+          attributes[:auth] = @auth
+        end
+      end
+
+      # @return [Hash] the parameters to submit to YouTube to get the resource.
+      # @see https://developers.google.com/youtube/v3/docs/commentThreads#resource
+      def list_params
+        super.tap do |params|
+          params[:path] = "/youtube/v3/commentThreads"
+          params[:params] = comments_params
+        end
+      end
+
+      def comments_params
+        apply_where_params!({max_results: 100, part: 'snippet'}).tap do |params|
+          case @parent
+          when Yt::Video
+            params[:videoId] = @parent.id
+          when Yt::Channel
+            params[:channelId] = @parent.id
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yt/models/comment_thread.rb

@@ -2,21 +2,21 @@ require 'yt/models/resource'
 
 module Yt
   module Models
-    # Provides methods to interact with YouTube channels.
+    # Provides methods to interact with YouTube comment thread.
     # @see https://developers.google.com/youtube/v3/docs/commentThreads
     class CommentThread < Resource
 
     ### SNIPPET ###
 
       # @!attribute [r] video_id
-      #   @return [String] the ID of the video that the comments refer to, if
-      #   any. If this property is not present or does not have a value, then
-      #   the thread applies to the channel and not to a specific video.
+      #   @return [String] the ID of the video that the comment thread referto, if
+      #   any. If this property is not present or does not have a value, then the
+      #   thread applies to the channel and not to a specific video.
       delegate :video_id, to: :snippet
 
       # @!attribute [r] total_reply_count
       #   @return [String] The total number of replies that have been submitted 
-      #   in response to the top-level comment.
+      #   in response to the top level comment.
       delegate :total_reply_count, to: :snippet
 
       # @return [Boolean] whether the thread, including all of its comments and
@@ -25,6 +25,26 @@ module Yt
 
       # @return [Boolean] whether the current viewer can reply to the thread.
       delegate :can_reply?, to: :snippet
+
+      # @!attribute [r] top_level_comment
+      #   @return [Yt::TopLevelComment] the top level comment object.
+      delegate :top_level_comment, to: :snippet
+
+      # @!attribute [r] text_display
+      #   @return [String] the top level comment's display text.
+      delegate :text_display, to: :top_level_comment
+
+      # @!attribute [r] author_display_name
+      #   @return [String] the top level comment's author name.
+      delegate :author_display_name, to: :top_level_comment
+
+      # @!attribute [r] like_count
+      #   @return [String] the top level comment's likes count.
+      delegate :like_count, to: :top_level_comment
+
+      # @!attribute [r] updated_at
+      #   @return [String] the top level comment's last updated time.
+      delegate :updated_at, to: :top_level_comment
     end
   end
 end

data/lib/yt/models/snippet.rb

@@ -1,4 +1,5 @@
 require 'yt/models/description'
+require 'yt/models/comment'
 
 module Yt
   module Models
@@ -38,7 +39,6 @@ module Yt
       has_attribute :like_count, type: Integer
       has_attribute :updated_at, type: Time
 
-
       def thumbnail_url(size = :default)
         thumbnails.fetch(size.to_s, {})['url']
       end
@@ -51,6 +51,10 @@ module Yt
         @can_reply ||= data.fetch 'canReply', false
       end
 
+      def top_level_comment
+        @top_level_comment ||= Yt::Comment.new data['topLevelComment'].symbolize_keys
+      end
+
       # Returns whether YouTube API includes all attributes in this snippet.
       # For instance, YouTube API only returns tags and categoryId on
       # Videos#list, not on Videos#search. And returns position on

data/lib/yt/models/video.rb

@@ -369,6 +369,9 @@ module Yt
       delegate :concurrent_viewers, to: :live_streaming_detail
 
     ### ASSOCIATIONS ###
+      # @!attribute [r] comments
+      #   @return [Yt::Collections::Comments] the video’s comments.
+      has_many :comment_threads
 
       # @!attribute [r] annotations
       #   @return [Yt::Collections::Annotations] the video’s annotations.

data/lib/yt/version.rb

@@ -1,3 +1,3 @@
 module Yt
-  VERSION = '0.25.26'
+  VERSION = '0.25.27'
 end

data/spec/collections/comment_threads_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+require 'yt/collections/comment_threads'
+require 'yt/models/video'
+require 'yt/models/channel'
+
+describe Yt::Collections::CommentThreads do
+  subject(:collection) { Yt::Collections::CommentThreads.new parent: parent}
+
+  describe '#size', :ruby2 do
+    describe 'sends only one request and return the total results' do
+      let(:total_results) { 1234 }
+      let(:parent) { Yt::Video.new id: 'any-id' }
+
+      before do
+        expect_any_instance_of(Yt::Request).to receive(:run).once do
+          double(body: {'pageInfo'=>{'totalResults'=>total_results}})
+        end
+      end
+      it { expect(collection.size).to be total_results }
+    end
+  end
+
+  describe '#count' do
+    let(:query) { {q: 'search string'} }
+    let(:parent) { Yt::Video.new id: 'any-id' }
+    let(:page) { {items: [], token: 'any-token'} }
+
+    context 'called once with .where(query) and once without' do
+      after do
+        collection.where(query).count
+        collection.count
+      end
+
+      it 'only applies the query on the first call' do
+        expect(collection).to receive(:fetch_page) do |options|
+          expect(options[:params]).to include query
+          page
+        end
+        expect(collection).to receive(:fetch_page) do |options|
+          expect(options[:params]).not_to include query
+          page
+        end
+      end
+    end
+  end
+end

data/spec/models/comment_thread_spec.rb

@@ -23,6 +23,38 @@ describe Yt::CommentThread do
     end
   end
 
+  describe '#top_level_comment' do
+    context 'given a snippet with a top level comment' do
+      let(:attrs) { {snippet: {"topLevelComment"=> {}}} }
+      it { expect(comment_thread.top_level_comment).to be_a Yt::Comment }
+    end
+  end
+
+  describe 'attributes from #top_level_comment delegations' do
+    context 'with values' do
+      let(:attrs) { {snippet: {"topLevelComment"=> {"id" => "xyz123", "snippet" => {
+        "textDisplay" => "funny video!",
+        "authorDisplayName" => "fullscreen",
+        "likeCount" => 99,
+        "updatedAt" => "2016-03-22T12:56:56.3Z"}}}} }
+
+      it { expect(comment_thread.top_level_comment.id).to eq 'xyz123' }
+      it { expect(comment_thread.text_display).to eq 'funny video!' }
+      it { expect(comment_thread.author_display_name).to eq 'fullscreen' }
+      it { expect(comment_thread.like_count).to eq 99 }
+      it { expect(comment_thread.updated_at).to eq Time.parse('2016-03-22T12:56:56.3Z') }
+    end
+
+    context 'without values' do
+      let(:attrs) { {snippet: {"topLevelComment"=> {"snippet" => {}}}} }
+
+      it { expect(comment_thread.text_display).to be_nil }
+      it { expect(comment_thread.author_display_name).to be_nil }
+      it { expect(comment_thread.like_count).to be_nil }
+      it { expect(comment_thread.updated_at).to be_nil }
+    end
+  end
+
   describe '#total_reply_count' do
     context 'given a snippet with a total reply count' do
       let(:attrs) { {snippet: {"totalReplyCount"=>1}} }

data/spec/requests/as_server_app/comment_thread_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require 'yt/models/comment_thread'
+require 'yt/models/comment'
 
 describe Yt::CommentThread, :server_app do
   subject(:comment_thread) { Yt::CommentThread.new attrs }
@@ -11,6 +12,12 @@ describe Yt::CommentThread, :server_app do
     it { expect(comment_thread.total_reply_count).to be_an Integer }
     it { expect(comment_thread.can_reply?).to be false }
     it { expect(comment_thread).to be_public }
+
+    it { expect(comment_thread.top_level_comment).to be_a Yt::Comment }
+    it { expect(comment_thread.text_display).not_to be_empty }
+    it { expect(comment_thread.author_display_name).not_to be_empty }
+    it { expect(comment_thread.updated_at).to be_a Time }
+    it { expect(comment_thread.like_count).to be_a Integer }
   end
 
   context 'given an comment thread ID about a video' do

data/spec/requests/as_server_app/comment_threads_spec.rb

@@ -0,0 +1,41 @@
+# encoding: UTF-8
+require 'spec_helper'
+require 'yt/collections/comment_threads'
+require 'yt/models/video'
+require 'yt/models/channel'
+
+describe Yt::Collections::CommentThreads, :server_app do
+  context "without parent association", :ruby2 do
+    subject(:comment_threads) { Yt::Collections::CommentThreads.new }
+
+    specify 'without given any of id, videoId, channelId or allThreadsRelatedToChannelId param, raise request error', :ruby2 do
+      expect{ comment_threads.size }.to raise_error(Yt::Errors::RequestError)
+    end
+
+    specify 'with a id param, only return one comment thread' do
+      expect(comment_threads.where(id: 'z13zytsilxbexh30e233gdyyttngfjfz104').size).to eq 1
+    end
+
+    specify 'with a videoId param, returns comment threads for the video', focus: true do
+      expect(comment_threads.where(videoId: 'MsplPPW7tFo').size).to be > 0
+    end
+
+    specify 'with a channelId param, returns comment threads for the channel' do
+      expect(comment_threads.where(channelId: 'UC-lHJZR3Gqxm24_Vd_AJ5Yw').size).to be > 0
+    end
+  end
+
+  context "with parent association", :ruby2 do
+    subject(:comment_threads) { Yt::Collections::CommentThreads.new parent: parent}
+
+    context "parent as video" do
+      let(:parent) { Yt::Models::Video.new id: 'MsplPPW7tFo' }
+      it { expect(comment_threads.size).to be > 0 }
+    end
+
+    context "parent as channel" do
+      let(:parent) { Yt::Models::Channel.new id: 'UC-lHJZR3Gqxm24_Vd_AJ5Yw' }
+      it { expect(comment_threads.size).to be > 0 }
+    end
+  end
+end

data/spec/requests/as_server_app/video_spec.rb

@@ -1,11 +1,12 @@
 require 'spec_helper'
 require 'yt/models/video'
+require 'yt/collections/comment_threads'
 
 describe Yt::Video, :server_app do
   subject(:video) { Yt::Video.new attrs }
 
   context 'given an existing video ID' do
-    let(:attrs) { {id: 'MESycYJytkU'} }
+    let(:attrs) { {id: 'L3JDXvz7G6c'} }
 
     it { expect(video.content_detail).to be_a Yt::ContentDetail }
 
@@ -27,11 +28,11 @@ describe Yt::Video, :server_app do
   end
 
   context 'given an existing video URL' do
-    let(:attrs) { {url: 'https://www.youtube.com/watch?v=MESycYJytkU&list=LLxO1tY8h1AhOz0T4ENwmpow'} }
+    let(:attrs) { {url: 'https://www.youtube.com/watch?v=L3JDXvz7G6c'} }
 
     specify 'provides access to its data' do
-      expect(video.id).to eq 'MESycYJytkU'
-      expect(video.title).to eq 'Fullscreen Creator Platform'
+      expect(video.id).to eq 'L3JDXvz7G6c'
+      expect(video.title).to eq "you’re in fullscreen"
       expect(video.privacy_status).to eq 'public'
     end
   end
@@ -55,4 +56,24 @@ describe Yt::Video, :server_app do
     end
   end
 
-end
+  describe 'associations' do
+    let(:attrs) { {id: 'MsplPPW7tFo'} }
+
+    describe '#comment_threads' do
+      it { expect(video.comment_threads).to be_a Yt::Collections::CommentThreads }
+      it { expect(video.comment_threads.first.top_level_comment).to be_a Yt::Models::Comment }
+    end
+
+    describe '#comment_threads.each_cons' do
+      it {
+        comment_threads = []
+        video.comment_threads.each_cons(2).take_while do |items|
+          comment_threads += items
+          comment_threads.size < 6
+        end
+        expect(comment_threads.size).to be 6
+      }
+    end
+  end
+end
+

data/spec/requests/as_server_app/videos_spec.rb

@@ -22,7 +22,7 @@ describe Yt::Collections::Videos, :server_app do
   end
 
   specify 'with a chart parameter, only returns videos of that chart', :ruby2 do
-    expect(videos.where(chart: 'mostPopular').size).to be 30
+    expect(videos.where(chart: 'mostPopular').size).to be 200
   end
 
   context 'with a list of parts' do
@@ -37,4 +37,4 @@ describe Yt::Collections::Videos, :server_app do
       expect(video.instance_variable_defined? :@content_detail).to be true
     end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yt
 version: !ruby/object:Gem::Version
-  version: 0.25.26
+  version: 0.25.27
 platform: ruby
 authors:
 - Claudio Baccigalupo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-24 00:00:00.000000000 Z
+date: 2016-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -137,6 +137,7 @@ files:
 - lib/yt/collections/channels.rb
 - lib/yt/collections/claim_histories.rb
 - lib/yt/collections/claims.rb
+- lib/yt/collections/comment_threads.rb
 - lib/yt/collections/content_details.rb
 - lib/yt/collections/content_owner_details.rb
 - lib/yt/collections/content_owners.rb
@@ -229,6 +230,7 @@ files:
 - lib/yt/request.rb
 - lib/yt/version.rb
 - spec/collections/claims_spec.rb
+- spec/collections/comment_threads_spec.rb
 - spec/collections/playlist_items_spec.rb
 - spec/collections/playlists_spec.rb
 - spec/collections/policies_spec.rb
@@ -300,6 +302,7 @@ files:
 - spec/requests/as_server_app/channel_spec.rb
 - spec/requests/as_server_app/comment_spec.rb
 - spec/requests/as_server_app/comment_thread_spec.rb
+- spec/requests/as_server_app/comment_threads_spec.rb
 - spec/requests/as_server_app/playlist_item_spec.rb
 - spec/requests/as_server_app/playlist_spec.rb
 - spec/requests/as_server_app/video_spec.rb
@@ -336,6 +339,7 @@ summary: Yt makes it easy to interact with Youtube V3 API by providing a modular
   intuitive and tested Ruby-style API.
 test_files:
 - spec/collections/claims_spec.rb
+- spec/collections/comment_threads_spec.rb
 - spec/collections/playlist_items_spec.rb
 - spec/collections/playlists_spec.rb
 - spec/collections/policies_spec.rb
@@ -407,6 +411,7 @@ test_files:
 - spec/requests/as_server_app/channel_spec.rb
 - spec/requests/as_server_app/comment_spec.rb
 - spec/requests/as_server_app/comment_thread_spec.rb
+- spec/requests/as_server_app/comment_threads_spec.rb
 - spec/requests/as_server_app/playlist_item_spec.rb
 - spec/requests/as_server_app/playlist_spec.rb
 - spec/requests/as_server_app/video_spec.rb