yt-core 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bcf250be4dd09edba92d177ab388d0e6ad9c1c7c
-  data.tar.gz: 73302bb09f7fa918fb68d040c0c157e4ea171cd4
+  metadata.gz: 38fe8ee547f6c51750be3b935de33654304a92bc
+  data.tar.gz: ca5b035d73c726d4f9f4a2428b3a4cc6cb573515
 SHA512:
-  metadata.gz: 11ad4095e3cba36dac088c13fe60084e3fb3b3a172e83b4a2e0ad893032a86d77afb7e9ffca71145be8a8140b891063eef3b0dbc52f0448a6224fcee5c2e4d58
-  data.tar.gz: f86ceb9904d7480b89b41a0c4d33d93d9056265381085cd9566a4908b7200de69f869b4317a29eea23163093e0a887537c4b404c663f2135aeef12017b474760
+  metadata.gz: 3201de66a86b9df6caf10792426616f01ea177153983090cb32d1bd19f83f99b947b79f9012d4e33f34411930e5f3c978664d6d9c3f7b2c536ccbb4412523a52
+  data.tar.gz: 0f1daea896d3ea422837992e8b3f1aeefb04d0576af63e51f783ae00ac5234b45ccf7ce3d77b2fc84578968fc1e69a37befb9ac9d32b3c3cfb7ef2669c0653b1

data/.travis.yml

@@ -1,6 +1,11 @@
 language: ruby
 rvm:
-  - 2.2.2
+- 2.2.2
 script:
-  - bundle exec rspec
-  - bundle exec yard stats | grep "100.00% documented"
+- bundle exec rspec
+- bundle exec yard stats | grep "100.00% documented"
+notifications:
+  slack:
+    secure: q+C+6nmfAg0W3ZqmqCyV7cRJXoJX22WPHodEYI5WVE7PY2Y42phHOIipXeUFta3CF3VO5sk4MLXh08y0WtShi/ZGpUui0ZH8aimplUlPbbmwKukAGAwYJp7q/trU3hPZd2CkQoBBWNmJsx2aU4X39aYpUOExYrSwW4Cu17hgW1y2m3kxNJyOocuaAuMZyWYY8ktH0C5sVfL0LR7U8Ct8B9D72yyXzLrPOlTWkrln7e82tirh318XqWRM8YLLLGkwaOBqptxkNbmbNu/y+SKiqixcSUPDhLAjRXsByhDlR2f9kZsQZJ/1YnQFl/SygiL39JNMWY8aiHkN15N5iWiocalw/r+oSdZApWf7Ts69cgtoPGxNDt8L73FXs5tnhNOEkm/3kc+Vkq7mnrvX1l0Z0wqdcmZekiw31u30j/j6GU2WHC3C4taJ9TJIc7AfNUntg0l1GXh1aKi62pEdVVgJWLPU8MKXn0Z+2Me2ALrFjfGkfbGXD1lbIlQ/UfyiDyzmqN+DpT7UNcUuXKH4N/BoJtqr9upnXZsVIr0+mVD0/rpo7lZtNHsYaP1BtywKcKdXs4TNHSV51cE3ZUtAweGRsgnQsLWtszQPPG98OLFpqJP5wKRaAuIEI0134uf6V+DqWyICPY6oGX1BTbm8LuXCby7I8ErHI4V16tWuiNm6ojQ=
+    on_success: never
+    on_failure: change

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.1.5 - 2017-08-24
+
+* [FEATURE] Add `Yt::PlaylistItem.insert` and `Yt::PlaylistItem#delete`
+* [FEATURE] Add `Channel#related_playlists` and `Channel#like_playlists`
+* [FEATURE] Add Channel.mine
+
 ## 0.1.4 - 2017-06-02
 
 * [FEATURE] Add CommentThread#comments

data/README.md

@@ -57,11 +57,21 @@ To run live-tests against the YouTube API, type:
 rspec
 ```
 
-This will fail unless you have set up a test YouTube application with access to
-the YouTube Data API v3 and an environment variable:
+Note that some tests actually hit the YouTube API, and therefore require
+either an API key or authentication credentials.
 
-- `YT_SERVER_API_KEY`: API Key of a Google app with access to the YouTube Data API v3 and the YouTube Analytics API
+In order to run tests marked as :server you need to set up a test YouTube
+application with access to the YouTube Data API v3 and an environment variable:
 
+- `YT_SERVER_API_KEY`: API Key of a Google app with access to the YouTube Data API v3
+
+In order to run tests marked as :account you als need to create a client ID
+and secret and then generate a refresh token for the account you want to use
+as test. Make sure this account has a channel with at least one playlist:
+
+- `YT_ACCOUNT_CLIENT_ID`: Client ID of a Google app with access to the YouTube Data API v3
+- `YT_ACCOUNT_CLIENT_SECRET`: Client Secret of a Google app with access to the YouTube Data API v3
+- `YT_ACCOUNT_REFRESH_TOKEN`: Refresh token of a YouTube account for the app above
 
 How to release new versions
 ===========================

data/docs/channels.html

@@ -32,6 +32,21 @@ channel = Yt::Channel.new id: 'UCwCnUcLcb9-eSrHa_RQGkQQ'         ## use any chan
 channel.title # => "Yt Test"
 {% endhighlight %}
 
+
+<p>
+  Other methods <strong>acts on behalf of YouTube accounts</strong> (e.g.: subscribe to a channel, delete playlists).<br />
+  To use these methods (marked with  <span class="label label-warning">&nbsp;</span> below), you need to <a href="{{ site.baseurl }}/#api_client">get an API Client ID/Secret from Google</a>, then <a href="{{ site.baseurl }}/#tokens">obtain a refresh token</a> from the account you want to act as, and finally configure the values:
+</p>
+
+{% highlight ruby %}
+Yt.configuration.client_id = "<your ID>"           ## replace with your client ID
+Yt.configuration.client_secret = "<your secret>"   ## replace with your client secret
+Yt.configuration.refresh_token = "<token>"         ## use the account’s refresh token
+
+channel = Yt::Channel.mine
+# => #<Yt::Channel @id=UCwCnUcLcb9-eSrHa_RQGkQQ>
+{% endhighlight %}
+
 <hr />
 <h4>List of <code>Yt::Channel</code> data methods</h4>
 <dl>
@@ -70,6 +85,12 @@ channel.title # => "Yt Test"
 {% 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>
+
+  {% include dt.html title="Channel’s content details" label="warning" auth="must authenticate as the channel’s account" %}
+  <dd><a class="anchor" id="content_details"></a><div class="highlight"><pre>
+{% include doc.html instance="Channel#related_playlists" %}{% include example.html object='channel' method='related_playlists' result='{"likes"=>"LLwCncb9-e", "watchHistory"=>"HL"}' %}
+{% include doc.html instance="Channel#like_playlists" %}{% include example.html object='channel' method='like_playlists' result='#&lt;Yt::Relation [#&lt;Yt::Playlist @id=LLWCncb...&gt;]&gt;' %}</pre>
+  </div></dd>
 </dl>
 <p>
   To limit the number of HTTP requests, use <code>select</code> to specify which <a href="https://developers.google.com/youtube/v3/docs/channels/list#part">parts</a> of the channel’s data to load:
@@ -142,3 +163,11 @@ channel.title # => "Yt Test"
   The previous method returns existing channels that match the provided IDs, skipping any unrecognized ID.<br />
   As usual, use <code>select</code> to specify which <a href="https://developers.google.com/youtube/v3/docs/channels/list#part">parts</a> of each channels’s data to load before iterating through the list.
 </p>
+
+<dl>
+  {% include dt.html title="Authenticated account’s channel" label="warning" auth="must authenticate as the channel’s account" %}
+  <dd><a class="anchor" id="mine"></a><div class="highlight"><pre>
+{% include doc.html class="Channel#mine" %}{% include example.html object='<span class="no">Yt</span><span class="o">::</span><span class="no">Channel</span>' method='mine' %}
+{% include example.html result='#&lt;Yt::Channel @id=UCwCnUcLcb9-eSrHa_RQGkQQ&gt;' %}</pre>
+  </div></dd>
+</dl>

data/docs/playlist_items.html

@@ -27,6 +27,20 @@ item = Yt::PlaylistItem.new id: 'UEwtTGVUdXRjOUdSS0Qze' ## use any playlist item
 item.position # => 0
 {% endhighlight %}
 
+<p>
+  Other methods <strong>acts on behalf of YouTube accounts</strong> (e.g.: add an item to a playlist).<br />
+  To use these methods (marked with  <span class="label label-warning">&nbsp;</span> below), you need to <a href="{{ site.baseurl }}/#api_client">get an API Client ID/Secret from Google</a>, then <a href="{{ site.baseurl }}/#tokens">obtain a refresh token</a> from the account you want to act as, and finally configure the values:
+</p>
+
+{% highlight ruby %}
+Yt.configuration.client_id = "<your ID>"           ## replace with your client ID
+Yt.configuration.client_secret = "<your secret>"   ## replace with your client secret
+Yt.configuration.refresh_token = "<token>"         ## use the account’s refresh token
+
+Yt::PlaylistItem.insert playlist_id: 'PL-LeTutc9GRKD3DhnRF_y', video_id: 'gknzFj_0vvY'
+# => #<Yt::PlaylistItem:0x... @id=UEwtTGVUdXRjOUdSS0Qze>
+{% endhighlight %}
+
 <hr />
 <h4>List of <code>Yt::PlaylistItem</code> data methods</h4>
 <dl>
@@ -63,3 +77,10 @@ item.position # => 0
 {% include example.html object='fast' method='privacy_status' result='=> no extra HTTP requests' %}</pre>
   </div></dd>
 </dl>
+<dl>
+  {% include dt.html title="Adding and removing a playlist item" label="warning" auth="must authenticate as the channel’s account" %}
+  <dd><a class="anchor" id="insert_remove"></a><div class="highlight"><pre>
+{% include doc.html class="PlaylistItem#insert" %}{% include example.html object='item = <span class="no">Yt</span><span class="o">::</span><span class="no">PlaylistItem</span>' method='insert' params=' <span class="ss">playlist_id:</span> <span class="s1">"PL-..."</span>, <span class="ss">video_id:</span> <span class="s1">"gknzFj_0vvY"</span>' %}
+{% include doc.html instance="PlaylistItem#delete" %}{% include example.html object='item' method='delete' result='true' %}</pre>
+  </div></dd>
+</dl>

data/lib/yt/channel.rb

@@ -91,6 +91,11 @@ module Yt
     #   channels module.
     has_attribute :featured_channels_urls, in: %i(branding_settings channel), default: []
 
+    # @!attribute [r] related_playlists
+    # @return [Hash] the playlists associated with the channel, such as the
+    #   channel's uploaded videos, liked videos, and watch history.
+    has_attribute :related_playlists, in: :content_details
+
     # @return [String] the canonical form of the channel’s URL.
     def canonical_url
       "https://www.youtube.com/channel/#{id}"
@@ -122,7 +127,7 @@ module Yt
     # @see https://developers.google.com/youtube/v3/docs/search/list#channelId
     def videos
       @videos ||= Relation.new(Video, channel_id: id, limit: 500) do |options|
-        items = fetch '/youtube/v3/search', channel_videos_params(options)
+        items = get '/youtube/v3/search', channel_videos_params(options)
         videos_for items, 'id', options
       end
     end
@@ -130,8 +135,31 @@ module Yt
     # @return [Yt::Relation<Yt::Playlist>] the public playlists of the channel.
     def playlists
       @playlists ||= Relation.new(Playlist, channel_id: id) do |options|
-        fetch '/youtube/v3/playlists', channel_playlists_params(options)
+        get '/youtube/v3/playlists', channel_playlists_params(options)
       end
     end
+
+    # @return [Yt::Relation<Yt::Playlist>] the playlists associated with
+    #   liked videos. Includes the deprecated favorites if still present.
+    def like_playlists
+      @like_lists ||= Relation.new(Playlist, ids: like_list_ids) do |options|
+        get '/youtube/v3/playlists', resource_params(options)
+      end
+    end
+
+    # @return [Yt::Channel] the channel associated with the YouTube account
+    #   that provided the authentication token.
+    def self.mine
+      Relation.new(self) do |options|
+        get '/youtube/v3/channels', mine: true, part: 'id'
+      end.first
+    end
+
+  private
+
+    def like_list_ids
+      names = %w(likes favorites)
+      related_playlists.select{|name,_| names.include? name}.values
+    end
   end
 end

data/lib/yt/comment_thread.rb

@@ -20,7 +20,7 @@ module Yt
     def comments
       @comments ||= Relation.new(Comment, parent_id: id,
         initial_items: -> {[top_level_comment]}) do |options|
-        fetch '/youtube/v3/comments', thread_comments_params(options)
+        get '/youtube/v3/comments', thread_comments_params(options)
       end
     end
   end

data/lib/yt/core.rb

@@ -1,6 +1,7 @@
 require 'json' # for JSON.parse
 
 require 'yt/config'
+require 'yt/auth'
 require 'yt/no_items_error'
 require 'yt/http_request'
 require 'yt/relation'

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.4'
+    VERSION = '0.1.5'
   end
 end

data/lib/yt/playlist.rb

@@ -59,7 +59,7 @@ module Yt
     # @return [Yt::Relation<Yt::PlaylistItem>] the items of the playlist.
     def items
       @items ||= Relation.new(PlaylistItem, playlist_id: id) do |options|
-        fetch '/youtube/v3/playlistItems', playlist_items_params(options)
+        get '/youtube/v3/playlistItems', playlist_items_params(options)
       end
     end
 
@@ -67,7 +67,7 @@ module Yt
     def videos
       @videos ||= Relation.new(Video, playlist_id: id) do |options|
         params = playlist_items_params(options.merge parts: [:content_details])
-        items = fetch '/youtube/v3/playlistItems', params
+        items = get '/youtube/v3/playlistItems', params
         videos_for items, 'contentDetails', options
       end
     end

data/lib/yt/playlist_item.rb

@@ -55,5 +55,27 @@ module Yt
     def thumbnail_url(size = :default)
       thumbnails.fetch(size.to_s, {})['url']
     end
+
+    # @return [Yt::PlaylistItem] the item created by appending the given
+    #   video to the given playlist.
+    def self.insert(playlist_id:, video_id:)
+      parts = %i(id snippet)
+      items = -> (body) { [body] } # the response body only includes one item
+      resource_id = {kind: 'youtube#video', videoId: video_id}
+      snippet = {playlistId: playlist_id, resourceId: resource_id}
+
+      Relation.new(self, parts: parts, extract_items: items) do |options|
+        post '/youtube/v3/playlistItems', {part: 'snippet'}, {snippet: snippet}
+      end.first
+    end
+
+    # @return [Boolean] whether the item was removed from the playlist.
+    def delete
+      items = -> (body) { [{}] } # the response body is empty
+
+      Relation.new(PlaylistItem, id: id, extract_items: items) do |options|
+        delete '/youtube/v3/playlistItems', id: options[:id]
+      end.any?
+    end
   end
 end

data/lib/yt/relation.rb

@@ -9,7 +9,7 @@ module Yt
     # @yield [Hash] the options to change which items to iterate through.
     def initialize(item_class, options = {}, &item_block)
       @options = {parts: %i(id), limit: Float::INFINITY, item_class: item_class,
-        initial_items: -> {[]}}
+        initial_items: -> {[]}, extract_items: -> (body) {body['items']}}
       @options.merge! options
       @item_block = item_block
     end
@@ -27,10 +27,10 @@ module Yt
       @items ||= initial_items.dup
       if @items[@last_index].nil? && more_pages?
         response = Response.new(@options, &@item_block).run
-        more_items = response.body['items'].map do |item|
+        more_items = @options[:extract_items].call(response.body).map do |item|
           @options[:item_class].new attributes_for_new_item(item)
         end
-        @options.merge! offset: response.body['nextPageToken']
+        @options.merge! offset: response.body['nextPageToken'] if response.body
         @items.concat more_items
       end
       @items[(@last_index +=1) -1]

data/lib/yt/resource.rb

@@ -34,7 +34,7 @@ module Yt
     def self.where(conditions = {})
       @where ||= Relation.new(self) do |options|
         slicing_conditions_every(50) do |slice_options|
-          fetch resources_path, where_params(slice_options)
+          get resources_path, where_params(slice_options)
         end
       end
       @where.where conditions
@@ -50,7 +50,7 @@ module Yt
       define_method name do
         keys = Array(options[:in]) + [name]
         part = keys.shift
-        value = @data[part] || fetch_part(part)
+        value = @data[part] || get_part(part)
         keys.each{|key| value = value[camelize key]}
         if value.nil? && options[:default]
           value = options[:default]
@@ -60,9 +60,9 @@ module Yt
       end
     end
 
-    def fetch_part(required_part)
+    def get_part(required_part)
       resources = Relation.new(self.class, ids: [id]) do |options|
-        fetch resources_path, resource_params(options)
+        get resources_path, resource_params(options)
       end
 
       parts = (@selected_data_parts + [required_part]).uniq

data/lib/yt/response.rb

@@ -12,8 +12,47 @@ module Yt
 
   private
 
-    def fetch(path, params)
-      HTTPRequest.new(path: path, params: params).run
+    def get(path, params = {})
+      request :get, path: path, params: params
+    end
+
+    def post(path, params = {}, body = {})
+      request :post, path: path, params: params, body: body
+    end
+
+    def delete(path, params = {})
+      request :delete, path: path, params: params
+    end
+
+    def request(method, options = {})
+      HTTPRequest.new(request_options options.merge method: method).run
+    rescue HTTPError => error
+      if unauthorized?(error) && refresh_access_token
+        retry
+      else
+        raise
+      end
+    end
+
+    def request_options(options)
+      options[:error_message] = ->(body) {JSON(body)['error']['message']}
+      if access_token = Yt.configuration.access_token || refresh_access_token
+        options[:headers] = {'Authorization' => "Bearer #{access_token}"}
+      else
+        options[:params] = options[:params].merge key: Yt.configuration.api_key
+      end
+      options
+    end
+
+    def unauthorized?(error)
+      error.response.is_a? Net::HTTPUnauthorized
+    end
+
+    def refresh_access_token
+      if Yt.configuration.refresh_token
+        auth = Auth.new refresh_token: Yt.configuration.refresh_token
+        Yt.configuration.access_token = auth.access_token
+      end
     end
 
     def resources_path
@@ -55,7 +94,6 @@ module Yt
     def default_params(options)
       {}.tap do |params|
         params[:max_results] = 50
-        params[:key] = Yt.configuration.api_key
         params[:part] = options[:parts].join ','
         params[:page_token] = options[:offset]
       end
@@ -90,7 +128,7 @@ module Yt
       else
         options[:ids] = items.body['items'].map{|item| item['id']}
         options[:offset] = nil
-        fetch('/youtube/v3/videos', resource_params(options)).tap do |response|
+        get('/youtube/v3/videos', resource_params(options)).tap do |response|
           response.body['nextPageToken'] = items.body['nextPageToken']
         end
       end

data/lib/yt/video.rb

@@ -183,7 +183,7 @@ module Yt
     # @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)
+        get '/youtube/v3/commentThreads', video_threads_params(options)
       end
     end
 

data/yt-core.gemspec

@@ -23,7 +23,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'yt-support', '>= 0.1.2'
+  spec.add_dependency 'yt-auth', '>= 0.2.3'
+  spec.add_dependency 'yt-support', '>= 0.1.3'
 
   spec.add_development_dependency 'bundler', '~> 1.14'
   spec.add_development_dependency 'rspec', '~> 3.5'

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: yt-core
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Claudio Baccigalupo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-06 00:00:00.000000000 Z
+date: 2017-08-24 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: yt-auth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.3
 - !ruby/object:Gem::Dependency
   name: yt-support
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.1.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.1.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement