yt 0.25.25 → 0.25.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1335f7c1a7bb273da431dd594490731ecbcb54a7
-  data.tar.gz: 16c2b3b3b522e228be01312e2e453f2a431928a8
+  metadata.gz: 78dee68c38b98a14d9213c8f01b507425e25cca2
+  data.tar.gz: f859f557aef4fa1a76940ddaa5488af2515cb0df
 SHA512:
-  metadata.gz: 74d26b785280270e58896fba613dea5a2a167d1e9b134ab65130d01c8cee34b16328cbea597f6cb37b3754a1d04cd6bfc44a3e324f130f589522deeaa813a26e
-  data.tar.gz: b716f6a38a7c55e3037377600571b555c5cc07973600485b0e1003ffdf20e205e2e667bdb4058f4c029df3ece0d4228e214bdad3f3b099d7c97f6c6a669916c2
+  metadata.gz: a98d8b324a2c866fb4ad872e22f7eda31c69dbfc4ce66e11abf5f63fa9a9e497b489a3554ba09baf1c4102b746829ca5fa29eecff3e93dea2887288e4a4ab88d
+  data.tar.gz: 8f0da58402c694c51f1b229bf4fd9afe0f2c638893d9086311bb82734639ae523c73b28d6ae441359dc309a2883d0ddfb549bfef56c95468b3648fc4a6cea3f1

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.26 - 2016-03-24
+
+* [FEATURE] Add Yt::Comment resource.
+
 ## 0.25.25 - 2016-03-24
 
 * [FEATURE] Add Yt::CommentThread resource.

data/README.md

@@ -121,7 +121,7 @@ Yt::CommentThread
 
 Use [Yt::CommentThread](http://www.rubydoc.info/gems/yt/Yt/Models/CommentThread) to:
 
-* Show details of a comment_thread
+* Show details of a comment_thread.
 
 ```ruby
 Yt::CommentThread.new id: 'z13vsnnbwtv4sbnug232erczcmi3wzaug'
@@ -132,6 +132,23 @@ comment_thread.can_reply? #=> true
 comment_thread.public? #=> true
 ```
 
+Yt::Comment
+----------------
+
+Use [Yt::Comment](http://www.rubydoc.info/gems/yt/Yt/Models/Comment) to:
+
+* Get details of a comment.
+
+```ruby
+Yt::Comment.new id: 'z13vsnnbwtv4sbnug232erczcmi3wzaug'
+
+comment.text_display #=> "awesome"
+comment.author_display_name #=> "Jack"
+comment.like_count #=> 1
+comment.updated_at #=> 2016-03-22 12:56:56 UTC
+comment.parent_id #=> "abc1234" (return nil if the comment is not a reply)
+```
+
 Yt::Collections::Videos
 -----------------------
 

data/lib/yt/models/comment.rb

@@ -0,0 +1,37 @@
+require 'yt/models/resource'
+
+module Yt
+  module Models
+    # Provides methods to interact with YouTube comment.
+    # @see https://developers.google.com/youtube/v3/docs/comments
+    class Comment < Resource
+
+    ### SNIPPET ###
+
+      # @!attribute [r] video_id
+      #   @return [String] the ID of the video that the comment refers to.
+      delegate :video_id, to: :snippet
+
+      # @!attribute [r] author_display_name
+      #   @return [String] the display name of the user who posted the comment.
+      delegate :author_display_name, to: :snippet
+
+      # @!attribute [r] text_display
+      #   @return [String] the comment's text.
+      delegate :text_display, to: :snippet
+
+      # @!attribute [r] parent_id
+      #   @return [String] the unique ID of the parent comment. This property is only
+      #   set if the comment was submitted as a reply to another comment.
+      delegate :parent_id, to: :snippet
+
+      # @!attribute [r] like_count
+      #   @return [Integer] the total number of likes (positive ratings) the comment has received.
+      delegate :like_count, to: :snippet
+
+      # @!attribute [r] updated_at
+      #   @return [Time] the date and time when the comment was last updated.
+      delegate :updated_at, to: :snippet
+    end
+  end
+end

data/lib/yt/models/snippet.rb

@@ -8,7 +8,8 @@ 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
+    # @see https://developers.google.com/youtube/v3/docs/commentThreads#resource
+    # @see https://developers.google.com/youtube/v3/docs/comments#resource
     class Snippet < Base
       attr_reader :data
 
@@ -31,6 +32,12 @@ module Yt
       has_attribute :thumbnails, default: {}
       has_attribute :video_id
       has_attribute :total_reply_count, type: Integer
+      has_attribute :author_display_name
+      has_attribute :text_display
+      has_attribute :parent_id
+      has_attribute :like_count, type: Integer
+      has_attribute :updated_at, type: Time
+
 
       def thumbnail_url(size = :default)
         thumbnails.fetch(size.to_s, {})['url']

data/lib/yt/version.rb

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

data/spec/models/comment_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+require 'yt/models/comment'
+
+describe Yt::Comment do
+  subject(:comment) { Yt::Comment.new attrs }
+
+  describe '#snippet' do
+    context 'given fetching a comment returns a snippet' do
+      let(:attrs) { {snippet: {"videoId" => "12345"}} }
+      it { expect(comment.snippet).to be_a Yt::Snippet }
+    end
+  end
+
+  describe 'attributes' do
+    examples = {
+      video_id: {with: 'xyz123', without: nil},
+      parent_id: {with: 'abc123', without: nil},
+      text_display: {with: 'awesome', without: nil},
+      author_display_name: {with: 'John', without: nil},
+      like_count: {with: 10, without: nil},
+      updated_at: {input: '2016-03-22T12:56:56.3Z', with: Time.parse('2016-03-22T12:56:56.3Z'), without: nil},
+    }
+
+    examples.each do |attr, cases|
+      describe "##{attr}" do
+        context "given a snippet with a #{attr}" do
+          let(:attrs) {
+            {snippet: {"#{attr.to_s.camelize(:lower)}" => cases[:input] || cases[:with]}}}
+          it { expect(comment.send(attr)).to eq cases[:with] }
+        end
+
+        context "given a snippet without a #{attr}" do
+          let(:attrs) { {snippet: {}} }
+          it { expect(comment.send(attr)).to eq cases[:without] }
+        end
+      end
+    end
+  end
+end
+

data/spec/requests/as_server_app/comment_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+require 'yt/models/comment'
+
+describe Yt::Comment, :server_app do
+  subject(:comment) { Yt::Comment.new attrs }
+
+  context 'given an existing comment (non-reply) ID' do
+    let(:attrs) { {id: 'z13kc1bxpp22hzaxr04cd1kreurbjja41q00k'} }
+
+    it { expect(comment.parent_id).to be_nil }
+    it { expect(comment.text_display).to be_a String }
+    it { expect(comment.author_display_name).to be_a String }
+    it { expect(comment.like_count).to be_a Integer }
+    it { expect(comment.updated_at).to be_a Time }
+  end
+
+  context 'given an existing comment (reply) ID' do
+    let(:attrs) { {id: 'z13kc1bxpp22hzaxr04cd1kreurbjja41q00k.1458679991141996'} }
+
+    it { expect(comment.parent_id).to be_a String }
+  end
+
+  context 'given an unknown comment ID' do
+    let(:attrs) { {id: 'not-a-comment-id'} }
+    it { expect{comment.text_display}.to raise_error Yt::Errors::NoItems }
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yt
 version: !ruby/object:Gem::Version
-  version: 0.25.25
+  version: 0.25.26
 platform: ruby
 authors:
 - Claudio Baccigalupo
@@ -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.rb
 - lib/yt/models/comment_thread.rb
 - lib/yt/models/configuration.rb
 - lib/yt/models/content_detail.rb
@@ -249,6 +250,7 @@ files:
 - spec/models/claim_event_spec.rb
 - spec/models/claim_history_spec.rb
 - spec/models/claim_spec.rb
+- spec/models/comment_spec.rb
 - spec/models/comment_thread_spec.rb
 - spec/models/configuration_spec.rb
 - spec/models/content_detail_spec.rb
@@ -296,6 +298,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_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
@@ -354,6 +357,7 @@ test_files:
 - spec/models/claim_event_spec.rb
 - spec/models/claim_history_spec.rb
 - spec/models/claim_spec.rb
+- spec/models/comment_spec.rb
 - spec/models/comment_thread_spec.rb
 - spec/models/configuration_spec.rb
 - spec/models/content_detail_spec.rb
@@ -401,6 +405,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_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