yt-core 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2faf158ad48511fe585519deb4cd053f41bd2ffe
-  data.tar.gz: 3bb7780ffa69dedefc4094be10a43af205c868b8
+  metadata.gz: 368c82a9dfd70ec0b355a4d1789e30ea9092c178
+  data.tar.gz: 274884baeadb9e15cc58acf719bee6712a24bec4
 SHA512:
-  metadata.gz: f3445d6fa3b8836a51dfb02a25399780d58e705101c609a07be0d4fa94b9be0acbef06b320af917cc69d42dc8224275217da5700643f3b6b0c66d9f2e0077e4c
-  data.tar.gz: 99bb22df52a1a9895f40b6e52b8f4ae956b0bf556887acbbb42e4324cdf7487351db7ecb177e16b40564d7293080da1e5d27b6585160e6bafa2cfcf3f45d7907
+  metadata.gz: fc56f8e8ecac5151fedf2082584cf02e6eaee572adbe461801a5a2372c4ea84dd3250300bbf392dce0101eb654f18fb522771325e0bd10e3df7af4d5fef8e791
+  data.tar.gz: 5f56a363ea52f728a7a1ca0f5f0a568f793961f918f712fe23e049c9075981858a49232ad8ed0563ac4a00e0beb544844597511d029bd9aa05518cfa63bb1a41

data/.rspec

@@ -1,3 +1,2 @@
 --format documentation
 --color
---fail-fast

data/.travis.yml

@@ -1,6 +1,4 @@
 language: ruby
-notifications:
-  email: false
 rvm:
   - 2.2.2
 script:

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.1.3 - 2017-05-23
+
+* [FEATURE] Add Comment and CommentThread
+* [FEATURE] Add Channel#featured_channels_title and Channel#featured_channels_urls
+
 ## 0.1.2 - 2017-04-06
 
 * [BUGFIX] Fix cases like `channel.select(:snippet).view_count` where attribute does not belong to any selected part.

data/README.md

@@ -10,7 +10,7 @@ The **source code** is available on [GitHub](https://github.com/fullscreen/yt-co
 [![Dependency Status](http://img.shields.io/gemnasium/Fullscreen/yt-core.svg)](https://gemnasium.com/Fullscreen/yt-core)
 [![Code Climate](http://img.shields.io/codeclimate/github/Fullscreen/yt-core.svg)](https://codeclimate.com/github/Fullscreen/yt-core)
 [![Online docs](http://img.shields.io/badge/docs-✓-green.svg)](http://www.rubydoc.info/gems/yt-core/frames)
-[![Gem Version](http://img.shields.io/gem/v/yt.svg)](http://rubygems.org/gems/yt-core)
+[![Gem Version](http://img.shields.io/gem/v/yt-core.svg)](http://rubygems.org/gems/yt-core)
 
 After [registering your app](https://fullscreen.github.io/yt-core/), you can run commands like:
 

data/docs/_layouts/default.html

@@ -33,6 +33,11 @@
               {% else %}
                 <li><a href="{{ site.baseurl }}/playlist_items.html">Playlist Items</a></li>
               {% endif %}
+              {% if page.url == '/comments.html' %}
+                <li><a href="{{ site.baseurl }}/comments.html" class="active">Comments</a></li>
+              {% else %}
+                <li><a href="{{ site.baseurl }}/comments.html">Comments</a></li>
+              {% endif %}
               {% if page.url == '/errors.html' %}
                 <li><a href="{{ site.baseurl }}/errors.html" class="active">Errors</a></li>
               {% else %}

data/docs/channels.html

@@ -66,7 +66,9 @@ channel.title # => "Yt Test"
   <dd><a class="anchor" id="branding_settings"></a><div class="highlight"><pre>
 {% include doc.html instance="Channel#banner_image_url" %}{% include example.html object='channel' method='banner_image_url' result='"https://yt3.ggpht.com/9dh4rj-k-no"' %}
 {% include doc.html instance="Channel#keywords" %}{% include example.html object='channel' method='keywords' result='["Some", "tag"]' %}
-{% include doc.html instance="Channel#unsubscribed_trailer" %}{% include example.html object='channel' method='unsubscribed_trailer' result='"gknzFj_0vvY"' %}</pre>
+{% include doc.html instance="Channel#unsubscribed_trailer" %}{% include example.html object='channel' method='unsubscribed_trailer' result='"gknzFj_0vvY"' %}
+{% include doc.html instance="Channel#featured_channels_title" %}{% include example.html object='channel' method='featured_channels_title' result='"Featured channels"' %}
+{% include doc.html instance="Channel#featured_channels_urls" %}{% include example.html object='channel' method='featured_channels_urls' result='["UCxO1tY8h1AhOz0T4ENwmpow"]' %}</pre>
   </div></dd>
 </dl>
 <p>

data/docs/comments.html

@@ -0,0 +1,57 @@
+---
+title:  "Yt::CommentThread and Yt::Comment"
+h2: "Comments"
+---
+
+<p>
+  <code>Yt::CommentThread</code> represents a <a href="https://developers.google.com/youtube/v3/docs/commentThread">YouTube comment thread</a>.
+  Initialize using its YouTube ID:
+</p>
+
+<dl>
+  <dd><a class="anchor" id="new"></a><div class="highlight"><pre>
+{% include doc.html instance="CommentThread#initialize" %}{% include example.html object='thread = <span class="no">Yt</span><span class="o">::</span><span class="no">CommentThread</span>' method='new' params=' <span class="ss">id:</span> <span class="s1">"z121srzx5oqiyrbce23nevcwrpqfenix004"</span>' %}
+{% include example.html result='#&lt;Yt::CommentThread @id=z121srzx5oqiyrbce23nevcwrpqfenix004&gt;' %}
+{% include doc.html instance="CommentThread#canonical_url" %}{% include example.html object='thread' method='top_level_comment.text_display' %}
+{% include example.html result='"A public comment"' %}</pre>
+  </div></dd>
+</dl>
+
+<hr />
+<h4>Authentication</h4>
+
+<p>
+  Most methods of <code>Yt::CommentThread</code> <strong>retrieve public data</strong> from YouTube (e.g.: the top level comment).<br />
+  To use these methods (marked with <span class="label label-success">&nbsp;</span> below), you only need to <a href="{{ site.baseurl }}/#api_key">generate an API key</a> and configure:
+</p>
+
+{% highlight ruby %}
+Yt.configuration.api_key = "<your api key>"                        ## use your API key
+
+thread = Yt::CommentThread.new id: 'z121srzx5oqiyrbce23nevcwrpqfenix004' ## use any ID
+thread.top_level_comment.text_display # => "A public comment"
+{% endhighlight %}
+
+<hr />
+<h4>List of <code>Yt::CommentThread</code> data methods</h4>
+<dl>
+  {% include dt.html title="CommentThread’s snippet" label="success" auth="any authentication works" %}
+  <dd><a class="anchor" id="snippet"></a><div class="highlight"><pre>
+{% include doc.html instance="CommentThread#id" %}{% include example.html object='thread' method='id' result='"z121srzx5oqiyrbce23nevcwrpqfenix004"' %}
+{% include doc.html instance="CommentThread#channel_id" %}{% include example.html object='thread' method='channel_id' result='nil' %}
+{% include doc.html instance="CommentThread#video_id" %}{% include example.html object='thread' method='video_id' result='"gknzFj_0vvY"' %}
+{% include doc.html instance="CommentThread#top_level_comment" %}{% include example.html object='thread' method='top_level_comment' result='&lt;Yt::Comment @id=z121srzx5...&gt;' %}</pre>
+  </div></dd>
+
+<hr />
+<h4>List of <code>Yt::Comment</code> data methods</h4>
+<dl>
+  {% include dt.html title="Comment’s snippet" label="success" auth="any authentication works" %}
+  <dd><a class="anchor" id="snippet"></a><div class="highlight"><pre>
+{% include doc.html instance="Comment#id" %}{% include example.html object='comment' method='id' result='"z121srzx5oqiyrbce23nevcwrpqfenix004"' %}
+{% include doc.html instance="Comment#text_display" %}{% include example.html object='comment' method='text_display' result='"A public comment"' %}
+{% include doc.html instance="Comment#author_display_name" %}{% include example.html object='comment' method='author_display_name' result='"Yt Test"' %}
+{% include doc.html instance="Comment#author_profile_image_url" %}{% include example.html object='comment' method='author_profile_image_url' result='"https://yt3.ggpht.com/-lC#w"' %}
+{% include doc.html instance="Comment#author_channel_url" %}{% include example.html object='comment' method='author_channel_url' result='"http://www.youtube.com/channel/UCwCnUcLc..."' %}
+{% include doc.html instance="Comment#author_channel_id" %}{% include example.html object='comment' method='author_channel_id' result='"UCwCnUcLcb9-eSrHa_RQGkQQ"' %}</pre>
+  </div></dd>

data/docs/videos.html

@@ -102,3 +102,39 @@ video.title # => "First public video"
 {% include example.html result='#&lt;Yt::Channel @id=UCwCnUcLcb9-eSrHa_RQGkQQ&gt;' %}</pre>
   </div></dd>
 </dl>
+
+
+<dl>
+  {% include dt.html title="Video’s comment threads" label="success" auth="any authentication works" %}
+  <dd><a class="anchor" id="threads"></a><div class="highlight"><pre>
+{% include doc.html instance="Video#threads" %}{% include example.html object='video' method='threads' %}
+{% include example.html result='#&lt;Yt::Relation [#&lt;Yt::Thread @id=z119d45&gt;, #&lt;Yt::Thread @id=z120d734&gt;, ...]&gt;' %}</pre>
+  </div></dd>
+</dl>
+<p>
+  Before iterating through threads, use <code>select</code> to specify which <a href="https://developers.google.com/youtube/v3/docs/commentThreads/list#part">parts</a> to load:
+</p>
+<dl>
+  <dd><a class="anchor" id="select"></a><div class="highlight"><pre>
+{% include doc.html instance="Relation#select" %}{% include example.html object='threads = video.threads' method='select' params=' <span class="ss">:id</span>, <span class="ss">:snippet</span>' %}
+{% include example.html object='threads' method='map <span class="ss">&amp;:id</span>' result='["z119d45", ...]' %}
+{% include example.html object='threads' method='map <span class="ss">&amp;:top_level_comment</span>' result='[#&lt;Yt::Comment @id=z119d45&gt;, ...]' %}</pre>
+  </div></dd>
+</dl>
+<p>
+  You can also use <code>limit</code> to only fetch a certain number of threads:
+</p>
+<dl>
+  <dd><a class="anchor" id="limit"></a><div class="highlight"><pre>
+{% include doc.html instance="Relation#limit" %}{% include example.html object='threads = video.threads' method='limit' params=' <span class="mi">2</span>' %}
+{% include example.html object='threads' method='map <span class="ss">&amp;:id</span>' result='["z119d45", "z120d734"]' %}</pre>
+  </div></dd>
+</dl>
+<p>
+  You can also use <code>size</code> to quickly obtain the estimated number of threads:
+</p>
+<dl>
+  <dd><a class="anchor" id="size"></a><div class="highlight"><pre>
+{% include doc.html instance="Relation#size" %}{% include example.html object='video.threads' method='size' result='63' %}</pre>
+  </div></dd>
+</dl>

data/lib/yt/channel.rb

@@ -81,6 +81,16 @@ module Yt
     #   in the channel page’s browse view for unsubscribed viewers.
     has_attribute :unsubscribed_trailer, in: %i(branding_settings channel)
 
+    # @!attribute [r] featured_channels_title
+    # @return [<String, nil>] the title that displays above the featured
+    #   channels module. The title has a maximum length of 30 characters.
+    has_attribute :featured_channels_title, in: %i(branding_settings channel)
+
+    # @!attribute [r] featured_channels_title
+    # @return [Array<String>] the IDs of the channels linked in the featured
+    #   channels module.
+    has_attribute :featured_channels_urls, in: %i(branding_settings channel), default: []
+
     # @return [String] the canonical form of the channel’s URL.
     def canonical_url
       "https://www.youtube.com/channel/#{id}"

data/lib/yt/comment.rb

@@ -0,0 +1,27 @@
+module Yt
+  # Provides methods to interact with YouTube comments.
+  # @see https://developers.google.com/youtube/v3/docs/comments
+  class Comment < Resource
+    # @!attribute [r] author_channel_id
+    # @return [String] the comment’s text.
+    has_attribute :text_display, in: :snippet
+
+    # @!attribute [r] author_display_name
+    # @return [String] the display name of the user who posted the comment.
+    has_attribute :author_display_name, in: :snippet
+
+    # @!attribute [r] author_profile_image_url
+    # @return [String] the URL of the avatar of the user who posted the comment.
+    has_attribute :author_profile_image_url, in: :snippet
+
+    # @!attribute [r] author_channel_url
+    # @return [String] the URL of the comment author’s YouTube channel.
+    has_attribute :author_channel_url, in: :snippet
+
+    # @!attribute [r] author_channel_id
+    # @return [String] the ID of the comment author’s YouTube channel.
+    has_attribute :author_channel_id, in: :snippet do |author_channel_id|
+      author_channel_id['value']
+    end
+  end
+end

data/lib/yt/comment_thread.rb

@@ -0,0 +1,19 @@
+module Yt
+  # Provides methods to interact with YouTube comment threads.
+  # @see https://developers.google.com/youtube/v3/docs/commentThreads
+  class CommentThread < Resource
+    # @!attribute [r] channel_id
+    # @return [String] the ID of the channel that the comments refer to.
+    # @return [nil] if the comment does not refer to a channel.
+    has_attribute :channel_id, in: :snippet
+
+    # @!attribute [r] video_id
+    # @return [String] the ID of the video that the comments refer to.
+    # @return [nil] if the comment refers to the channel itself.
+    has_attribute :video_id, in: :snippet
+
+    # @!attribute [r] top_level_comment
+    # @return [Comment] the thread's top-level comment.
+    has_attribute :top_level_comment, in: :snippet, type: Comment
+  end
+end

data/lib/yt/core.rb

@@ -12,6 +12,9 @@ require 'yt/playlist'
 require 'yt/playlist_item'
 require 'yt/video'
 
+require 'yt/comment'
+require 'yt/comment_thread'
+
 # An object-oriented Ruby client for YouTube.
 # @see http://www.rubydoc.info/gems/yt/
 module Yt

data/lib/yt/core/version.rb

@@ -3,6 +3,6 @@ module Yt
   module Core
     # @return [String] the SemVer-compatible gem version.
     # @see http://semver.org
-    VERSION = '0.1.2'
+    VERSION = '0.1.3'
   end
 end

data/lib/yt/resource.rb

@@ -80,6 +80,8 @@ module Yt
         Time.parse value
       when [Integer]
         value.to_i
+      when [Comment]
+        Comment.new id: value['id'], snippet: value['snippet']
       else
         value
       end

data/lib/yt/response.rb

@@ -40,6 +40,10 @@ module Yt
       default_params(options).merge playlist_id: options[:playlist_id]
     end
 
+    def video_threads_params(options)
+      default_params(options).merge video_id: options[:video_id]
+    end
+
     def resource_params(options)
       default_params(options).merge id: options[:ids].join(',')
     end

data/lib/yt/video.rb

@@ -180,6 +180,13 @@ module Yt
       @channel ||= Channel.new id: channel_id
     end
 
+    # @return [Yt::Relation<Yt::CommentThread>] the threads of the video.
+    def threads
+      @threads ||= Relation.new(CommentThread, video_id: id) do |options|
+        fetch '/youtube/v3/commentThreads', video_threads_params(options)
+      end
+    end
+
   private
 
     # @return [Integer] the duration of the resource as reported by YouTube.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yt-core
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Claudio Baccigalupo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-06 00:00:00.000000000 Z
+date: 2017-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yt-support
@@ -150,6 +150,7 @@ files:
 - docs/_layouts/default.html
 - docs/apple-touch-icon-precomposed.png
 - docs/channels.html
+- docs/comments.html
 - docs/css/yt.css
 - docs/errors.html
 - docs/favicon.ico
@@ -179,6 +180,8 @@ files:
 - docs/urls.html
 - docs/videos.html
 - lib/yt/channel.rb
+- lib/yt/comment.rb
+- lib/yt/comment_thread.rb
 - lib/yt/core.rb
 - lib/yt/core/version.rb
 - lib/yt/no_items_error.rb