yt 0.13.9 → 0.13.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db12d589d5763d973797f580561eff7054db2643
-  data.tar.gz: 2e73f17f11c03ae2b1e3805ba855fa7e84eb7610
+  metadata.gz: f38c80c9cc34b749849ed9934a037fe7707614ce
+  data.tar.gz: 2a9a06c9f14a9fabe19aa0d74e47e2a2fe2aaf6f
 SHA512:
-  metadata.gz: 9cd65afd9ef4f2837604e2570fa3e404cec78fd183e9cb9cd0e7b0e1896c29cf53b50e2e210a1ed3d1688c747a9b12bffa93e14ed448c7efe35d7365beb34532
-  data.tar.gz: e78d7b773dc49accb73b6e33c3285f5cde7dca2c49da55b071ccd9437df46d79a3c83df5c93ed211ba552d0a15c5a0b698c329860c8073eb6235bd113c89ae64
+  metadata.gz: d39da84ceb5bd9941ea7a90b32ca01e2c94d1aa101289ac7ff012728663f08279bf2d6e961761aeb3043f973fe9304109d4449b95c45e78126784bc7d278bdc4
+  data.tar.gz: fed816b3f0ef773b7b3f1050135c1a1e08b953ada0ba4aeafc69571c9e0f0408158190a20bcb4be0f4bca803a246254d2738502fed05ec4b4c61f512e09c585c

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.13.9 - 2015-02-17
+
+* [FEATURE] New `video.upload_thumbnail` to upload the thumbnail for a video.
+
 ## 0.13.9 - 2015-02-16
 
 * [ENHANCEMENT] Accept `force: true` in `authentication_url` to force approval prompt.

data/README.md

@@ -236,6 +236,7 @@ Use [Yt::Video](http://rubydoc.info/github/Fullscreen/yt/master/Yt/Models/Video)
 
 * read the attributes of a video
 * update the attributes of a video
+* upload a thumbnail for a video
 * access the annotations of a video
 * delete a video
 * like and dislike a video
@@ -322,6 +323,9 @@ video = Yt::Video.new id: 'MESycYJytkU', auth: account
 video.update title: 'A title', description: 'A description <with angle brackets>'
 video.update tags: ['a tag'], categoryId: '21', license: 'creativeCommon'
 
+video.upload_thumbnail 'my_thumbnail.jpg'
+video.upload_thumbnail 'http://example.com/remote.png'
+
 video.views since: 7.days.ago #=> {Wed, 28 May 2014 => 12.0, Thu, 29 May 2014 => 3.0, …}
 video.comments until: 2.days.ago #=> {Wed, 28 May 2014 => 9.0, Thu, 29 May 2014 => 4.0, …}
 video.likes from: 8.days.ago #=> {Tue, 27 May 2014 => 7.0, Wed, 28 May 2014 => 0.0, …}

data/lib/yt/collections/resumable_sessions.rb

@@ -11,26 +11,12 @@ module Yt
     class ResumableSessions < Base
 
       # Starts a resumable session by sending to YouTube the metadata of the
-      # video to upload. If the request succeeds, YouTube returns a unique
-      # URL to upload the video file (and eventually resume the upload).
-      # @param [Integer] content_length the size (bytes) of the video to upload.
-      # @param [Hash] options the metadata to add to the uploaded video.
-      # @option options [String] :title The video’s title.
-      # @option options [String] :description The video’s description.
-      # @option options [Array<String>] :title The video’s tags.
-      # @option options [Integer] :category_id The video’s category ID.
-      # @option options [String] :privacy_status The video’s privacy status.
-      def insert(content_length, options = {})
+      # object to upload. If the request succeeds, YouTube returns a unique
+      # URL to upload the object file (and eventually resume the upload).
+      # @param [Integer] content_length the size (bytes) of the object to upload.
+      # @param [Hash] options the metadata to add to the uploaded object.
+      def insert(content_length, body = {})
         @headers = headers_for content_length
-        body = {}
-
-        snippet = options.slice :title, :description, :tags, :category_id
-        snippet[:categoryId] = snippet.delete(:category_id) if snippet[:category_id]
-        body[:snippet] = snippet if snippet.any?
-
-        status = options[:privacy_status]
-        body[:status] = {privacyStatus: status} if status
-
         do_insert body: body, headers: @headers
       end
 
@@ -43,15 +29,15 @@ module Yt
       def insert_params
         super.tap do |params|
           params[:response_format] = nil
-          params[:path] = '/upload/youtube/v3/videos'
-          params[:params] = {part: 'snippet,status', uploadType: 'resumable'}
+          params[:path] = @parent.upload_path
+          params[:params] = @parent.upload_params.merge uploadType: 'resumable'
         end
       end
 
       def headers_for(content_length)
         {}.tap do |headers|
           headers['x-upload-content-length'] = content_length
-          headers['X-Upload-Content-Type'] = 'video/*'
+          headers['X-Upload-Content-Type'] = @parent.upload_content_type
         end
       end
 

data/lib/yt/models/account.rb

@@ -46,7 +46,7 @@ module Yt
       #   @return [Yt::Collections::Playlists] the account’s playlists.
       has_many :playlists
 
-      # Uploads a video
+      # Uploads a video using resumable sessions
       # @param [String] path_or_url the video to upload. Can either be the
       #   path of a local file or the URL of a remote file.
       # @param [Hash] params the metadata to add to the uploaded video.
@@ -57,8 +57,11 @@ module Yt
       # @return [Yt::Models::Video] the newly uploaded video.
       def upload_video(path_or_url, params = {})
         file = open path_or_url, 'rb'
-        session = resumable_sessions.insert file.size, params
-        session.upload_video file
+        session = resumable_sessions.insert file.size, upload_body(params)
+
+        session.update(body: file) do |data|
+          Yt::Video.new id: data['id'], snippet: data['snippet'], status: data['privacyStatus'], auth: self
+        end
       end
 
       def create_playlist(params = {})
@@ -71,6 +74,38 @@ module Yt
       def videos_params
         {for_mine: true}
       end
+
+      # @private
+      # Tells `has_many :resumable_sessions` what path to hit to upload a file.
+      def upload_path
+        '/upload/youtube/v3/videos'
+      end
+      # @private
+      # Tells `has_many :resumable_sessions` what params are set for the object
+      # associated to the uploaded file.
+      def upload_params
+        {part: 'snippet,status'}
+      end
+
+      # @private
+      # Tells `has_many :resumable_sessions` what metadata to set in the object
+      # associated to the uploaded file.
+      def upload_body(params = {})
+        {}.tap do |body|
+          snippet = params.slice :title, :description, :tags, :category_id
+          snippet[:categoryId] = snippet.delete(:category_id) if snippet[:category_id]
+          body[:snippet] = snippet if snippet.any?
+
+          status = params[:privacy_status]
+          body[:status] = {privacyStatus: status} if status
+        end
+      end
+
+      # @private
+      # Tells `has_many :resumable_sessions` what type of file can be uploaded.
+      def upload_content_type
+        'video/*'
+      end
     end
   end
 end

data/lib/yt/models/resumable_session.rb

@@ -13,14 +13,17 @@ module Yt
         @headers = options[:headers]
       end
 
-      # Uploads a video using the current resumable session
-      # @param [#read] file A binary object that contains the video content.
+      def update(params = {})
+        do_update(params) {|data| yield data}
+      end
+
+      # Uploads a thumbnail using the current resumable session
+      # @param [#read] file A binary object that contains the image content.
       #   Can either be a File, a StringIO (for instance using open-uri), etc.
-      # @return [Yt::Models::Video] the newly uploaded video.
-      def upload_video(file)
-        do_update(body: file) do |data|
-          Yt::Video.new id: data['id'], snippet: data['snippet'], status: data['privacyStatus'], auth: @auth
-        end
+      # @return the new thumbnail resource for the given image.
+      # @see https://developers.google.com/youtube/v3/docs/thumbnails#resource
+      def upload_thumbnail(file)
+        do_update(body: file) {|data| data['items'].first}
       end
 
     private

data/lib/yt/models/video.rb

@@ -73,6 +73,11 @@ module Yt
       delegate :view_count, :like_count, :dislike_count, :favorite_count,
         :comment_count, to: :statistics_set
 
+      # @!attribute [r] resumable_sessions
+      #   @return [Yt::Collections::ResumableSessions] the sessions used to
+      #     upload thumbnails using the resumable upload protocol.
+      has_many :resumable_sessions
+
       # Override Resource's new to set statistics and content details as well
       # if the response includes them
       def initialize(options = {})
@@ -163,6 +168,20 @@ module Yt
         !liked?
       end
 
+      # Uploads a thumbnail
+      # @param [String] path_or_url the image to upload. Can either be the
+      #   path of a local file or the URL of a remote file.
+      # @return the new thumbnail resource for the given image.
+      # @see https://developers.google.com/youtube/v3/docs/thumbnails#resource
+      def upload_thumbnail(path_or_url)
+        file = open path_or_url, 'rb'
+        session = resumable_sessions.insert file.size
+
+        session.update(body: file) do |data|
+          snippet.instance_variable_set :@thumbnails, data['items'].first
+        end
+      end
+
       # @private
       # Tells `has_reports` to retrieve the reports from YouTube Analytics API
       # either as a Channel or as a Content Owner.
@@ -178,6 +197,24 @@ module Yt
         end
       end
 
+      # @private
+      # Tells `has_many :resumable_sessions` what path to hit to upload a file.
+      def upload_path
+        '/upload/youtube/v3/thumbnails/set'
+      end
+      # @private
+      # Tells `has_many :resumable_sessions` what params are set for the object
+      # associated to the uploaded file.
+      def upload_params
+        {video_id: id}
+      end
+
+      # @private
+      # Tells `has_many :resumable_sessions` what type of file can be uploaded.
+      def upload_content_type
+        'application/octet-stream'
+      end
+
     private
 
       # @see https://developers.google.com/youtube/v3/docs/videos/update

data/lib/yt/version.rb

@@ -1,3 +1,3 @@
 module Yt
-  VERSION = '0.13.9'
+  VERSION = '0.13.10'
 end

data/spec/requests/as_account/authentications_spec.rb

@@ -109,15 +109,9 @@ describe Yt::Account, :device_app do
         it { expect{account.authentication}.to raise_error Yt::Errors::MissingAuth }
       end
 
-      # @note: This test is a reflection of another irrational behavior of
-      #   YouTube API. When passing a wrong 'device_code', YouTube crashes and
-      #   raises 500, instead of an expected MissingAuth.
-      #   The day YouTube fixes it, then this test will finally fail and the
-      #   commented line will be restored.
       context 'and an invalid device code' do
         before { attrs[:device_code] = '--not-a-valid-device-code--' }
-        # it { expect{account.authentication}.to raise_error Yt::Errors::MissingAuth }
-        it { expect{account.authentication}.to raise_error Yt::Errors::ServerError }
+        it { expect{account.authentication}.to raise_error Yt::Errors::MissingAuth }
       end
     end
 

data/spec/requests/as_account/video_spec.rb

@@ -342,4 +342,26 @@ describe Yt::Video, :device_app do
       end
     end
   end
+
+  # @note: This should somehow test that the thumbnail *changes*. However,
+  #   YouTube does not change the URL of the thumbnail even though the content
+  #   changes. A full test would have to *download* the thumbnails before and
+  #   after, and compare the files. For now, not raising error is enough.
+  #   Eventually, change to `expect{update}.to change{video.thumbnail_url}`
+  context 'given one of my own videos for which I want to upload a thumbnail' do
+    let(:id) { $account.videos.where(order: 'viewCount').first.id }
+    let(:update) { video.upload_thumbnail path_or_url }
+
+    context 'given the path to a local JPG image file' do
+      let(:path_or_url) { File.expand_path '../thumbnail.jpg', __FILE__ }
+
+      it { expect{update}.not_to raise_error }
+    end
+
+    context 'given the path to a remote PNG image file' do
+      let(:path_or_url) { 'https://bit.ly/yt_thumbnail' }
+
+      it { expect{update}.not_to raise_error }
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yt
 version: !ruby/object:Gem::Version
-  version: 0.13.9
+  version: 0.13.10
 platform: ruby
 authors:
 - Claudio Baccigalupo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-16 00:00:00.000000000 Z
+date: 2015-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -257,6 +257,7 @@ files:
 - spec/requests/as_account/playlist_item_spec.rb
 - spec/requests/as_account/playlist_spec.rb
 - spec/requests/as_account/resource_spec.rb
+- spec/requests/as_account/thumbnail.jpg
 - spec/requests/as_account/video.mp4
 - spec/requests/as_account/video_spec.rb
 - spec/requests/as_content_owner/account_spec.rb
@@ -353,6 +354,7 @@ test_files:
 - spec/requests/as_account/playlist_item_spec.rb
 - spec/requests/as_account/playlist_spec.rb
 - spec/requests/as_account/resource_spec.rb
+- spec/requests/as_account/thumbnail.jpg
 - spec/requests/as_account/video.mp4
 - spec/requests/as_account/video_spec.rb
 - spec/requests/as_content_owner/account_spec.rb