yt 0.25.24 → 0.25.25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69646f9b5f3274e30a937499733d3dbfa31db71a
-  data.tar.gz: 895fb71e79bbf91c05903c96c05b33f5f2155357
+  metadata.gz: 1335f7c1a7bb273da431dd594490731ecbcb54a7
+  data.tar.gz: 16c2b3b3b522e228be01312e2e453f2a431928a8
 SHA512:
-  metadata.gz: b6b837f47d06ce91154d7a42742616d04534cdc313293f315c59f151fc75966cad5103c1eaa505323cae51dd1f005e1712eb216352c9292355c1181b955d9d1b
-  data.tar.gz: 8bf87aef4cce7fcd4ec28c0cc3e31b646f43bf03d4b0119495aa16cc9560a110f04a19b1674a585faac84510c781cb89863dea00372417c28f39ff15bb511652
+  metadata.gz: 74d26b785280270e58896fba613dea5a2a167d1e9b134ab65130d01c8cee34b16328cbea597f6cb37b3754a1d04cd6bfc44a3e324f130f589522deeaa813a26e
+  data.tar.gz: b716f6a38a7c55e3037377600571b555c5cc07973600485b0e1003ffdf20e205e2e667bdb4058f4c029df3ece0d4228e214bdad3f3b099d7c97f6c6a669916c2

data/CHANGELOG.md

@@ -6,6 +6,10 @@ For more information about changelogs, check
 [Keep a Changelog](http://keepachangelog.com) and
 [Vandamme](http://tech-angels.github.io/vandamme).
 
+## 0.25.25 - 2016-03-24
+
+* [FEATURE] Add Yt::CommentThread resource.
+
 ## 0.25.24 - 2016-03-02
 
 * [BUGFIX] When `videos.where(..)` returns more than one page, don’t retain the items for the next request.

data/README.md

@@ -116,6 +116,22 @@ Yt::PlaylistItem
 
 Check [fullscreen.github.io/yt](http://fullscreen.github.io/yt/playlist_items.html) for the list of methods available for `Yt::PlaylistItem`.
 
+Yt::CommentThread
+----------------
+
+Use [Yt::CommentThread](http://www.rubydoc.info/gems/yt/Yt/Models/CommentThread) to:
+
+* Show details of a comment_thread
+
+```ruby
+Yt::CommentThread.new id: 'z13vsnnbwtv4sbnug232erczcmi3wzaug'
+
+comment_thread.video_id #=> "1234"
+comment_thread.total_reply_count #=> 1
+comment_thread.can_reply? #=> true
+comment_thread.public? #=> true
+```
+
 Yt::Collections::Videos
 -----------------------
 

data/lib/yt.rb

@@ -11,6 +11,7 @@ require 'yt/models/playlist'
 require 'yt/models/playlist_item'
 require 'yt/models/video'
 require 'yt/models/video_group'
+require 'yt/models/comment_thread'
 require 'yt/models/ownership'
 require 'yt/models/advertising_options_set'
 
@@ -20,4 +21,4 @@ require 'yt/models/advertising_options_set'
 # ...), YouTube Analytics API V2 resources (metrics, earnings, ...), and
 # objects not available through the API (annotations).
 module Yt
-end
+end

data/lib/yt/models/comment_thread.rb

@@ -0,0 +1,30 @@
+require 'yt/models/resource'
+
+module Yt
+  module Models
+    # Provides methods to interact with YouTube channels.
+    # @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.
+      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.
+      delegate :total_reply_count, to: :snippet
+
+      # @return [Boolean] whether the thread, including all of its comments and
+      # comment replies, is visible to all YouTube users.
+      delegate :public?, to: :snippet
+
+      # @return [Boolean] whether the current viewer can reply to the thread.
+      delegate :can_reply?, to: :snippet
+    end
+  end
+end

data/lib/yt/models/snippet.rb

@@ -8,6 +8,7 @@ module Yt
     # @see https://developers.google.com/youtube/v3/docs/videos#resource
     # @see https://developers.google.com/youtube/v3/docs/playlists#resource
     # @see https://developers.google.com/youtube/v3/docs/playlistItems#resource
+    # @see https://developers.google.com/youtube/v3/docs/commentThread#resource
     class Snippet < Base
       attr_reader :data
 
@@ -28,11 +29,21 @@ module Yt
       has_attribute :position, type: Integer
       has_attribute :resource_id, default: {}
       has_attribute :thumbnails, default: {}
+      has_attribute :video_id
+      has_attribute :total_reply_count, type: Integer
 
       def thumbnail_url(size = :default)
         thumbnails.fetch(size.to_s, {})['url']
       end
 
+      def public?
+        @public ||= data.fetch 'isPublic', false
+      end
+
+      def can_reply?
+        @can_reply ||= data.fetch 'canReply', false
+      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
@@ -47,4 +58,4 @@ module Yt
       end
     end
   end
-end
+end

data/lib/yt/version.rb

@@ -1,3 +1,3 @@
 module Yt
-  VERSION = '0.25.24'
+  VERSION = '0.25.25'
 end

data/spec/models/comment_thread_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+require 'yt/models/comment_thread'
+
+describe Yt::CommentThread do
+  subject(:comment_thread) { Yt::CommentThread.new attrs }
+
+  describe '#snippet' do
+    context 'given fetching a comment thread returns a snippet' do
+      let(:attrs) { {snippet: {"videoId" => "12345"}} }
+      it { expect(comment_thread.snippet).to be_a Yt::Snippet }
+    end
+  end
+
+  describe '#video_id' do
+    context 'given a snippet with a video id' do
+      let(:attrs) { {snippet: {"videoId"=>"12345"}} }
+      it { expect(comment_thread.video_id).to eq '12345' }
+    end
+
+    context 'given a snippet without a video id' do
+      let(:attrs) { {snippet: {}} }
+      it { expect(comment_thread.video_id).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}} }
+      it { expect(comment_thread.total_reply_count).to eq 1 }
+    end
+
+    context 'given a snippet without a total reply count' do
+      let(:attrs) { {snippet: {}} }
+      it { expect(comment_thread.total_reply_count).to be_nil }
+    end
+  end
+
+  describe '#can_reply?' do
+    context 'given a snippet with canReply set' do
+      let(:attrs) { {snippet: {"canReply"=>true}} }
+      it { expect(comment_thread.can_reply?).to be true }
+    end
+
+    context 'given a snippet without canReply set' do
+      let(:attrs) { {snippet: {}} }
+      it { expect(comment_thread.can_reply?).to be false }
+    end
+  end
+
+  describe '#is_public?' do
+    context 'given a snippet with isPublic set' do
+      let(:attrs) { {snippet: {"isPublic"=>true}} }
+      it { expect(comment_thread).to be_public }
+    end
+
+    context 'given a snippet without isPublic set' do
+      let(:attrs) { {snippet: {}} }
+      it { expect(comment_thread).to_not be_public }
+    end
+  end
+end

data/spec/requests/as_server_app/comment_thread_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+require 'yt/models/comment_thread'
+
+describe Yt::CommentThread, :server_app do
+  subject(:comment_thread) { Yt::CommentThread.new attrs }
+
+  context 'given an existing comment thread ID about a channel' do
+    let(:attrs) { {id: 'z13vsnnbwtv4sbnug232erczcmi3wzaug'} }
+
+    it { expect(comment_thread.video_id).to be_nil }
+    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 }
+  end
+
+  context 'given an comment thread ID about a video' do
+    let(:attrs) { {id: 'z13ij10h2z3qxpcte23hc5oh2vfzeptk4'} }
+    it { expect(comment_thread.video_id).to be_a String }
+  end
+
+  context 'given an unknown comment thread ID' do
+    let(:attrs) { {id: 'not-a-comment-thread-id'} }
+    it { expect{comment_thread.total_reply_count}.to raise_error Yt::Errors::NoItems }
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yt
 version: !ruby/object:Gem::Version
-  version: 0.25.24
+  version: 0.25.25
 platform: ruby
 authors:
 - Claudio Baccigalupo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-02 00:00:00.000000000 Z
+date: 2016-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -189,6 +189,7 @@ files:
 - lib/yt/models/claim.rb
 - lib/yt/models/claim_event.rb
 - lib/yt/models/claim_history.rb
+- lib/yt/models/comment_thread.rb
 - lib/yt/models/configuration.rb
 - lib/yt/models/content_detail.rb
 - lib/yt/models/content_owner.rb
@@ -248,6 +249,7 @@ files:
 - spec/models/claim_event_spec.rb
 - spec/models/claim_history_spec.rb
 - spec/models/claim_spec.rb
+- spec/models/comment_thread_spec.rb
 - spec/models/configuration_spec.rb
 - spec/models/content_detail_spec.rb
 - spec/models/content_owner_detail_spec.rb
@@ -294,6 +296,7 @@ files:
 - spec/requests/as_content_owner/video_group_spec.rb
 - spec/requests/as_content_owner/video_spec.rb
 - spec/requests/as_server_app/channel_spec.rb
+- spec/requests/as_server_app/comment_thread_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
@@ -351,6 +354,7 @@ test_files:
 - spec/models/claim_event_spec.rb
 - spec/models/claim_history_spec.rb
 - spec/models/claim_spec.rb
+- spec/models/comment_thread_spec.rb
 - spec/models/configuration_spec.rb
 - spec/models/content_detail_spec.rb
 - spec/models/content_owner_detail_spec.rb
@@ -397,6 +401,7 @@ test_files:
 - spec/requests/as_content_owner/video_group_spec.rb
 - spec/requests/as_content_owner/video_spec.rb
 - spec/requests/as_server_app/channel_spec.rb
+- spec/requests/as_server_app/comment_thread_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