yt 0.9.4 → 0.9.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 14049c251aa81b310d2a688eb83b8243e2777488
-  data.tar.gz: 67b28e266dccd1334cd69677f6d634b9e922e209
+  metadata.gz: a618a834dfa7b3cecfc38f24ea9d7c7f42db9ca3
+  data.tar.gz: 8136067b0f3568ac059e4eacfe0eb812c3c9c4e2
 SHA512:
-  metadata.gz: e34cd376159d465a5a7cd2963d6429d0d520bfd4a549dee7e8a48045205a619f1129380da62c1fb9d73f897ab4e08a88b24e54ac05f5300c3742cdb1956c6cde
-  data.tar.gz: 9c1a31d3cacdb4a69ba4d59a2ea4e3675f3bfb2e07cc61d336e55fb1695c1d88027eb0d023089ea29eea78ac9420345bf4f72e847908172de21bd1fb5e018d21
+  metadata.gz: adb13cd19177496972a8f43bf663716ce250ca8e0d53d8aa570efe82ae4b5b97371d9697bb3f90bdec1a1aa6d082f13a79096c9af777a70fe6f27e2a577819f9
+  data.tar.gz: 212188da7ddfd9dd7c17b62c6568ff51e1fcdc55cc63da4b13552bae96140338723a2fce7b82f025273bd3e538405fbb4da81fcf1d678f621feb4fc58da573e3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    yt (0.9.4)
+    yt (0.9.5)
       activesupport
 
 GEM

data/HISTORY.md

@@ -7,6 +7,7 @@ v0.9 - 2014/07/28
 * Let 'update' methods understand both under_score and camelCased parameters
 * Add claim.third_party?
 * Add actual_start_time, actual_end_time, scheduled_start_time, scheduled_end_time for live-streaming videos
+* Add privacy_status, public_stats_viewable, publish_at to the options that Video#update accepts
 
 v0.8 - 2014/07/18
 -----------------

data/README.md

@@ -41,7 +41,7 @@ To install on your system, run
 
 To use inside a bundled Ruby project, add this line to the Gemfile:
 
-    gem 'yt', '~> 0.9.4'
+    gem 'yt', '~> 0.9.5'
 
 Since the gem follows [Semantic Versioning](http://semver.org),
 indicating the full version in your Gemfile (~> *major*.*minor*.*patch*)

data/lib/yt/models/status.rb

@@ -1,3 +1,5 @@
+require 'yt/models/timestamp'
+
 module Yt
   module Models
     # Contains information about the status of a resource. The details of the
@@ -247,8 +249,9 @@ module Yt
       # @return [nil] if the resource is not a private video scheduled to be
       #   published.
       def scheduled_at
-        @scheduled_at ||= Time.parse @data['publishAt'] if scheduled?
+        @scheduled_at ||= Yt::Timestamp.parse @data['publishAt'] if scheduled?
       end
+      alias publish_at scheduled_at
 
       # Returns whether the video is scheduled to be published.
       # @return [Boolean] if the resource is a video, whether it is currently
@@ -295,6 +298,7 @@ module Yt
       def embeddable?
         @embeddable ||= @data['embeddable']
       end
+      alias embeddable embeddable?
 
 # Public stats (Video only)
 
@@ -308,6 +312,7 @@ module Yt
       def has_public_stats_viewable?
         @public_stats_viewable ||= @data['publicStatsViewable']
       end
+      alias public_stats_viewable has_public_stats_viewable?
 
     private
 

data/lib/yt/models/timestamp.rb

@@ -0,0 +1,12 @@
+module Yt
+  module Models
+    # Extend Time to have .to_json return the format needed to submit
+    # timestamp to YouTube API.
+    # Only needed while we support ActiveSupport 3.
+    class Timestamp < Time
+      def as_json(options = nil)
+        utc.iso8601(3)
+      end
+    end
+  end
+end

data/lib/yt/models/video.rb

@@ -11,11 +11,11 @@ module Yt
       delegate :deleted?, :failed?, :processed?, :rejected?, :uploaded?,
         :uses_unsupported_codec?, :has_failed_conversion?, :empty?, :invalid?,
         :too_small?, :aborted?, :claimed?, :infringes_copyright?, :duplicate?,
-        :scheduled_at, :scheduled?, :too_long?, :violates_terms_of_use?,
+        :scheduled_at, :publish_at, :scheduled?, :too_long?, :violates_terms_of_use?,
         :inappropriate?, :infringes_trademark?, :belongs_to_closed_account?,
         :belongs_to_suspended_account?, :licensed_as_creative_commons?,
         :licensed_as_standard_youtube?, :has_public_stats_viewable?,
-        :embeddable?, to: :status
+        :public_stats_viewable, :embeddable, :embeddable?, :license, to: :status
 
       # @!attribute [r] content_detail
       #   @return [Yt::Models::ContentDetail] the video’s content details.
@@ -83,14 +83,11 @@ module Yt
         !@id.nil?
       end
 
-      # @todo Update the status, not just the snippet. This requires some
-      #   caution, as the whole status object needs to be updated, not just
-      #   privacyStatus, but also embeddable, license, publicStatsViewable,
-      #   and publishAt
       def update(attributes = {})
         super attributes do |data|
           @id = data['id']
           @snippet = Snippet.new data: data['snippet'] if data['snippet']
+          @status = Status.new data: data['status'] if data['status']
           true
         end
       end
@@ -161,10 +158,12 @@ module Yt
     private
 
       # @see https://developers.google.com/youtube/v3/docs/videos/update
-      # @todo: Add status, recording details keys
+      # @todo: Add recording details keys
       def update_parts
         snippet_keys = [:title, :description, :tags, :category_id]
-        {snippet: {keys: snippet_keys}}
+        status_keys = [:privacy_status, :embeddable, :license,
+          :public_stats_viewable, :publish_at]
+        {snippet: {keys: snippet_keys}, status: {keys: status_keys}}
       end
     end
   end

data/lib/yt/version.rb

@@ -1,3 +1,3 @@
 module Yt
-  VERSION = '0.9.4'
+  VERSION = '0.9.5'
 end

data/spec/requests/as_account/video_spec.rb

@@ -194,6 +194,96 @@ describe Yt::Video, :device_app do
       end
     end
 
+    # note: 'scheduled' videos cannot be set to 'unlisted'
+    context 'given I update the privacy status' do
+      before { video.update publish_at: nil if video.scheduled? }
+      let!(:new_privacy_status) { old_privacy_status == 'private' ? 'unlisted' : 'private' }
+
+      context 'passing the parameter in underscore syntax' do
+        let(:attrs) { {privacy_status: new_privacy_status} }
+
+        specify 'only updates the privacy status' do
+          expect(update).to be true
+          expect(video.privacy_status).not_to eq old_privacy_status
+          expect(video.title).to eq old_title
+        end
+      end
+
+      context 'passing the parameter in camel-case syntax' do
+        let(:attrs) { {privacyStatus: new_privacy_status} }
+
+        specify 'only updates the privacy status' do
+          expect(update).to be true
+          expect(video.privacy_status).not_to eq old_privacy_status
+          expect(video.title).to eq old_title
+        end
+      end
+    end
+
+    context 'given I update the embeddable status' do
+      let!(:old_embeddable) { video.embeddable? }
+      let!(:new_embeddable) { !old_embeddable }
+
+      let(:attrs) { {embeddable: new_embeddable} }
+
+      # @note: This test is a reflection of another irrational behavior of
+      #   YouTube API. Although 'embeddable' can be passed as an 'update'
+      #   attribute according to the documentation, it simply does not work.
+      #   The day YouTube fixes it, then this test will finally fail and will
+      #   be removed, documenting how to update 'embeddable' too.
+      # @see https://developers.google.com/youtube/v3/docs/videos/update
+      # @see https://code.google.com/p/gdata-issues/issues/detail?id=4861
+      specify 'does not update the embeddable status' do
+        expect(update).to be true
+        expect(video.embeddable?).to eq old_embeddable
+      end
+    end
+
+    context 'given I update the license' do
+      let!(:old_license) { video.license }
+      let!(:new_license) { old_license == 'youtube' ? 'creativeCommon' : 'youtube' }
+      let(:attrs) { {license: new_license} }
+
+      # @note: This test is a reflection of another irrational behavior of
+      #   YouTube API. Although 'license' can be passed as an 'update'
+      #   attribute according to the documentation, it simply does not work.
+      #   The day YouTube fixes it, then this test will finally fail and will
+      #   be removed, documenting how to update 'embeddable' too.
+      # @see https://developers.google.com/youtube/v3/docs/videos/update
+      # @see https://code.google.com/p/gdata-issues/issues/detail?id=4861
+      specify 'does not update the embeddable status' do
+        expect(update).to be true
+        expect(video.license).to eq old_license
+      end
+    end
+
+    context 'given I update the public stats viewable setting' do
+      let!(:old_public_stats_viewable) { video.has_public_stats_viewable? }
+      let!(:new_public_stats_viewable) { !old_public_stats_viewable }
+
+      context 'passing the parameter in underscore syntax' do
+        let(:attrs) { {public_stats_viewable: new_public_stats_viewable} }
+
+        specify 'only updates the public stats viewable setting' do
+          expect(update).to be true
+          expect(video.has_public_stats_viewable?).to eq new_public_stats_viewable
+          expect(video.privacy_status).to eq old_privacy_status
+          expect(video.title).to eq old_title
+        end
+      end
+
+      context 'passing the parameter in camel-case syntax' do
+        let(:attrs) { {publicStatsViewable: new_public_stats_viewable} }
+
+        specify 'only updates the public stats viewable setting' do
+          expect(update).to be true
+          expect(video.has_public_stats_viewable?).to eq new_public_stats_viewable
+          expect(video.privacy_status).to eq old_privacy_status
+          expect(video.title).to eq old_title
+        end
+      end
+    end
+
     it 'returns valid reports for video-related metrics' do
       # Some reports are only available to Content Owners.
       # See content ownere test for more details about what the methods return.
@@ -219,4 +309,43 @@ describe Yt::Video, :device_app do
       expect{video.viewer_percentage}.not_to raise_error
     end
   end
+
+  # @note: This test is separated from the block above because, for some
+  #   undocumented reasons, if an existing video was private, then set to
+  #   unlisted, then set to private again, YouTube _sometimes_ raises a
+  #   400 Error when trying to set the publishAt timestamp.
+  #   Therefore, just to test the updating of publishAt, we use a brand new
+  #   video (set to private), rather than reusing an existing one as above.
+  context 'given one of my own *private* videos that I want to update' do
+    before { @tmp_video = $account.upload_video 'https://bit.ly/yt_test', title: old_title, privacy_status: old_privacy_status }
+    let(:id) { @tmp_video.id }
+    let!(:old_title) { "Yt Test Update publishAt Video #{rand}" }
+    let!(:old_privacy_status) { 'private' }
+    after  { video.delete}
+
+    let!(:new_scheduled_at) { Yt::Timestamp.parse("#{rand 30 + 1} Jan 2020", Time.now) }
+
+    context 'passing the parameter in underscore syntax' do
+      let(:attrs) { {publish_at: new_scheduled_at} }
+
+      specify 'only updates the timestamp to publish the video' do
+        expect(video.update attrs).to be true
+        expect(video.scheduled_at).to eq new_scheduled_at
+        expect(video.privacy_status).to eq old_privacy_status
+        expect(video.title).to eq old_title
+      end
+    end
+
+    context 'passing the parameter in camel-case syntax' do
+      let(:attrs) { {publishAt: new_scheduled_at} }
+
+      specify 'only updates the timestamp to publish the video' do
+        expect(video.update attrs).to be true
+        expect(video.scheduled_at).to eq new_scheduled_at
+        expect(video.privacy_status).to eq old_privacy_status
+        expect(video.title).to eq old_title
+      end
+    end
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yt
 version: !ruby/object:Gem::Version
-  version: 0.9.4
+  version: 0.9.5
 platform: ruby
 authors:
 - Claudio Baccigalupo
@@ -187,6 +187,7 @@ files:
 - lib/yt/models/statistics_set.rb
 - lib/yt/models/status.rb
 - lib/yt/models/subscription.rb
+- lib/yt/models/timestamp.rb
 - lib/yt/models/url.rb
 - lib/yt/models/user_info.rb
 - lib/yt/models/video.rb